checkintegeroverflow.h

Go to the documentation of this file.

/*
* Copyright 2016 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/

#pragma once

#include "gwnavruntime/math/vec2i.h"
#include "gwnavruntime/math/vec2ll.h"

namespace Kaim
{

// uncomment to assert on integer overflow
//#define KY_FULL_DEBUG_IntegerOverflow

#if defined(KY_FULL_DEBUG_IntegerOverflow)
KY_TEMPORARY_CODE
#endif


#ifdef KY_FULL_DEBUG_IntegerOverflow

inline void CheckPrecision(const Vec2LL& P)
{
    // Be sure that coordinates are on 31 bits to avoid overFlow (we don't check the sign bit)
    // 2^31 == 1LL << 31 = 2 147 483 648
    KY_DEV_BREAK_IF(P.x >= (1LL << 31) || -P.x >= (1LL << 31));
    KY_DEV_BREAK_IF(P.y >= (1LL << 31) || -P.y >= (1LL << 31));
}

inline void CheckPrecision(const Vec2LL& v1, const Vec2LL& v2, const Vec2LL& v3, const Vec2LL& v4, const Vec2LL& v5)
{
    CheckPrecision(v1);
    CheckPrecision(v2);
    CheckPrecision(v3);
    CheckPrecision(v4);
    CheckPrecision(v5);
}

inline void CheckPrecision(const Vec2LL& v1, const Vec2LL& v2, const Vec2LL& v3, const Vec2LL& v4, const Vec2LL& v5, const Vec2LL& v6)
{
    CheckPrecision(v1);
    CheckPrecision(v2);
    CheckPrecision(v3);
    CheckPrecision(v4);
    CheckPrecision(v5);
    CheckPrecision(v6);
}

inline void CheckPrecision(const Vec2i& P)
{
    // Be sure that coordinates are on 15 bits to avoid overFlow (we don't check the sign bit)
    // 2^15 == 1 << 15 = 32 768
    KY_DEV_BREAK_IF(P.x >= (1 << 15) || -P.x >= (1 << 15);
    KY_DEV_BREAK_IF(P.y >= (1 << 15) || -P.y >= (1 << 15);
}

inline void CheckPrecision(const Vec2i& v1, const Vec2i& v2, const Vec2i& v3, const Vec2i& v4, const Vec2i& v5, const Vec2i& v6)
{
    CheckPrecision(v1);
    CheckPrecision(v2);
    CheckPrecision(v3);
    CheckPrecision(v4);
    CheckPrecision(v5);
    CheckPrecision(v6);
}

inline void CheckPrecisionOn20Bits(KyInt64 x)
{
    KY_DEV_BREAK_IF((x >= 1LL << 20 || -x >= 1LL << 20));
}

inline void CheckPrecisionOn20Bits(KyInt64 x1, KyInt64 x2, KyInt64 x3, KyInt64 x4, KyInt64 x5, KyInt64 x6)
{
    CheckPrecisionOn20Bits(KyInt64 x1);
    CheckPrecisionOn20Bits(KyInt64 x2);
    CheckPrecisionOn20Bits(KyInt64 x3);
    CheckPrecisionOn20Bits(KyInt64 x4);
    CheckPrecisionOn20Bits(KyInt64 x5);
    CheckPrecisionOn20Bits(KyInt64 x6);
}


inline void AssertUnder8bits(const Vec2i& P)
{
    // Be sure that coordinates are on 8 bits to avoid overFlow (we don't check the sign bit)
    // 2^8 == 1 << 8
    KY_DEV_BREAK_IF(P.x >= (1 << 8) || -P.x >= (1 << 8);
    KY_DEV_BREAK_IF(P.y >= (1 << 8) || -P.y >= (1 << 8);
}

inline void AssertUnder8bits(const Vec2i& A, const Vec2i& B, const Vec2i& C, const Vec2i& D)
{
    AssertUnder8bits(A);
    AssertUnder8bits(B);
    AssertUnder8bits(C);
    AssertUnder8bits(D);
}

template<typename T>
inline void CheckDegenerated2d(const T& A, const T& B, const T& C, const T& D)
{
    KY_DEV_BREAK_IF(A.x == B.x && A.y == B.y);
    KY_DEV_BREAK_IF(C.x == D.x && C.y == D.y);
}

#else

inline void CheckPrecision(const Vec2LL&) {}
inline void CheckPrecision(const Vec2LL&, const Vec2LL&, const Vec2LL&, const Vec2LL&, const Vec2LL&) {}
inline void CheckPrecision(const Vec2LL&, const Vec2LL&, const Vec2LL&, const Vec2LL&, const Vec2LL&, const Vec2LL&) {}
inline void CheckPrecision(const Vec2i&) {}
inline void CheckPrecision(const Vec2i&, const Vec2i&, const Vec2i&, const Vec2i&, const Vec2i&, const Vec2i&) {}
inline void CheckPrecisionOn20Bits(KyInt64) {}
inline void CheckPrecisionOn20Bits(KyInt64, KyInt64, KyInt64, KyInt64, KyInt64, KyInt64) {}
inline void AssertUnder8bits(const Vec2i&) {}
inline void AssertUnder8bits(const Vec2i&, const Vec2i&, const Vec2i&, const Vec2i&) {}
template<typename T> inline void CheckDegenerated2d(const T&, const T&, const T&, const T&) {}

#endif

}