src_base_funcs.hh

Go to the documentation of this file.

/*
 * LEGAL:   COPYRIGHT (C) 2004 JIM E. BROOKS
 *          THIS SOURCE CODE IS RELEASED UNDER THE TERMS
 *          OF THE GNU GENERAL PUBLIC LICENSE VERSION 2 (GPL 2).
 *****************************************************************************/

#ifndef DOXYGEN  // doxygen can't parse this correctly
#ifndef BASE_FUNCS_HH
#define BASE_FUNCS_HH 1

namespace base {


// Min()/Max() is strongly recommended and faster if either arg is a computation,
// but requires both args to be the same type.
// Macro MIN()/MAX() lets the compiler automatically convert args of different types,
// but be warned: has the well-known side-effect of compiling each arg twice!
template<typename T> inline T Min( T a, T b ) { return (a < b) ? a : b; }
template<typename T> inline T Max( T a, T b ) { return (a > b) ? a : b; }
#ifndef MIN
#define MIN(A,B) ( ((A) < (B)) ? (A) : (B) )
#endif
#ifndef MAX
#define MAX(A,B) ( ((A) > (B)) ? (A) : (B) )
#endif

// Uses overloaded abs() from <cmath>.
#define ABS(X) std::abs((X))

// DEPRECATED
#ifndef STREQ
#define STREQ(A,B) ( strcmp((A),(B)) == 0 )
#endif
#ifndef STRNE
#define STRNE(A,B) ( strcmp((A),(B)) != 0 )
#endif
#ifndef STREMPTY
#define STREMPTY(S) ( ((S) == NULL) || ((S)[0] == '\0') )
#endif
#ifndef MEMEQ
#define MEMEQ(S1,S2,LEN) ( memcmp((S1),(S2),(LEN)) == 0 )
#endif
#ifndef MENNE
#define MEMNE(S1,S2,LEN) ( memcmp((S1),(S2),(LEN)) != 0 )
#endif
#define ELEMS(ARRAY) (uint( sizeof((ARRAY)) / sizeof((ARRAY)[0]) ))  // DEPRECATED

#define DELETE_NULL( OBJ ) delete (OBJ), (OBJ) = NULL

#define CLEAR_BIT_FIELDS( BIT_FIELD_PTR ) ( *(reinterpret_cast<unsigned int*>( (BIT_FIELD_PTR) )) = 0 )

// In case some cleanup function should be called instead.
void EXIT( int exitCode );


INLINE void
CLEAR( void* p, uint n )
{
    memset( p, 0, n );
}

INLINE int         NEG( int         x ) { return (x < 0) ? x : -x; }
INLINE long int    NEG( long int    x ) { return (x < 0) ? x : -x; }
INLINE float       NEG( float       x ) { return (x < 0) ? x : -x; }
INLINE double      NEG( double      x ) { return (x < 0) ? x : -x; }
INLINE long double NEG( long double x ) { return (x < 0) ? x : -x; }

INLINE bool
IfPow2( int n )
{
    // Trick: result is 0 if n is a power of 2.
//  return (n & (n-1)) == 0;  // bug: 0 isn't a power-of-2
    return (n != 0) and ((n & (n-1)) == 0);
}

INLINE bool IfEven( int n ) { return (n & 1) == 0; }
INLINE bool IfOdd( int n )  { return (n & 1) == 1; }

// +1 or -1 if true or false
INLINE int
PLUS_MINUS_1( bool plus )
{
    return plus ? 1 : -1;
}


template<typename T>
inline void
Swap( T& a, T& b )
{
    const T a2 = a;
    a = b;
    b = a2;
}

template<typename T>
bool
IfSameSign( T a, T b )
{
    return ((a  < 0) and (b  < 0))
        or ((a >= 0) and (b >= 0));  // 0 is positive
}

} // namespace base

#endif // BASE_FUNCS_HH
#endif // DOXYGEN

Palomino Flight Simulator documents generated by doxygen 1.5.6 on Mon Dec 29 17:26:59 2008