STK_Misc.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2007  Serge Iovleff

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as
    published by the Free Software Foundation; either version 2 of the
    License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this program; if not, write to the
    Free Software Foundation, Inc.,
    59 Temple Place,
    Suite 330,
    Boston, MA 02111-1307
    USA

    Contact : Serge.Iovleff@stkpp.org
*/

/*
 * Project:  Base
 * Purpose:  Define miscenaleous utility functions.
 * Author:   Serge Iovleff, serge.iovleff@stkpp.org
 *
 **/

#ifndef STK_MISC_H
#define STK_MISC_H

#include <cmath>
#include <cstdlib> // for rand

#include "STK_String.h"
#include "STK_Integer.h"
#include "STK_Real.h"
#include "STK_Stream.h"
#include "STK_Proxy.h"

namespace STK
{
template<class TYPE>
inline TYPE sign(TYPE const& x, TYPE const& y = 1)
{ return( (x<0) ? -y : y); }

template<class TYPE>
inline void swap(TYPE& x, TYPE& y)
{
  TYPE aux(x);
  x = y;
  y = aux;
}

template<class TYPE>
inline TYPE const& min(TYPE const& x, TYPE const& y)
{ return( (x<y) ? x : y); }

template<class TYPE>
inline TYPE const& max(TYPE const& x, TYPE const& y)
{ return( (x<y) ? y : x); }

template<class TYPE>
inline TYPE abs(TYPE const& x)
{ return( (x<0) ? -x : x); }

inline Real frand()
{ return (Real)rand() / (RAND_MAX+1.0);}

inline bool isOdd(Integer const& x)
{ return( (x%2) == 1 ); }

inline bool isEven(Integer const& x)
{ return( (x%2) == 0 ); }

inline Integer round(Real const& x)
{ return( x < 0.0 ? Integer(x-0.5) : Integer(x+0.5));}

inline Real norm(Real const& x, Real const& y)
{
  Real absx = abs(x), absy = abs(y);
  if (absx > absy)
  {
    return(absx * sqrt(double(1.0+(absy/absx)*(absy/absx))));
  }
  else
  {
    return(absy == 0.0 ? 0.0 : absy * sqrt(double(1.0+(absx/absy)*(absx/absy))));
  }
}

} // namespace STK

#endif /* STK_MISC_H */