source: Sophya/trunk/SophyaLib/TArray/utilarr.h@ 920

// This may look like C code, but it is really -*- C++ -*-
//     Utility classes for template numerical arrays 
//                     R. Ansari, C.Magneville   03/2000

#ifndef UtilArray_SEEN
#define UtilArray_SEEN

#include "machdefs.h"
#include <stdlib.h>

namespace SOPHYA {   

/* Quelques utilitaires pour les tableaux (Array) */             

//! define a function of double which returns a double
typedef double (* Arr_DoubleFunctionOfX) (double x);
//! define a function of float which returns a float
typedef float  (* Arr_FloatFunctionOfX)  (float x);

//////////////////////////////////////////////////////////
//! Class to generate a random sequence of values
/*!
  \class SOPHYA::RandomSequence
  \ingroup TArray
*/
class RandomSequence {
public:
  //! to define the generator type
  enum {
    Gaussian = 0, //!< gaussian generator
    Flat = 1      //!< Flat generator
    };

  RandomSequence(int typ = RandomSequence::Gaussian, double m=0., double s=1.);
  double Rand();
protected:
  int typ_;            //!< random generation type
  double mean_, sig_;  //!< generation parameters mean and sigma (if needed)
};


//////////////////////////////////////////////////////////
//! Class to generate a sequence of values
/*!
  \class SOPHYA::Sequence
  \ingroup TArray
*/
class Sequence {
public:
  explicit Sequence (double start=0., double step=1., Arr_DoubleFunctionOfX f=NULL);
  explicit Sequence (RandomSequence rseq);

  //! return start value of the sequence
  inline double & Start() { return start_; }
  //! return step value of the sequence
  inline double & Step() { return step_; }
  double operator () (uint_4 k);
protected:
  double start_;              //!< start value of the sequence
  double step_;               //!< step value of the sequence
  Arr_DoubleFunctionOfX myf_; //!< pointer to the sequence function
  bool fgrseq_;               //!< true if RandomSequence is used
  RandomSequence rseq_;       //!< RandomSequence
};

//////////////////////////////////////////////////////////
//! Class to define a range of indexes
/*!
  \class SOPHYA::Range
  \ingroup TArray
*/
class Range {
public:
  explicit Range(uint_4 start=0, uint_4 end=0, uint_4 size=1, uint_4 step=1);
  //! Return the start index
  inline uint_4 & Start()  {  return start_; }
  //! Return the last index
  inline uint_4 & End()    {  return end_; }
  //! Return the size
  inline uint_4 & Size()   {  return size_; }
  //! Return the step
  inline uint_4 & Step()   {  return step_; }
protected:
  uint_4 start_; //!< start index
  uint_4 end_;   //!< end index
  uint_4 size_;  //!< size
  uint_4 step_;  //!< step
};

//////////////////////////////////////////////////////////
//! Class to define an identity matrix
/*!
  \class SOPHYA::IdentityMatrix
  \ingroup TArray
*/
class IdentityMatrix {
public:
  explicit IdentityMatrix(double diag=1., uint_4 n=0);
  //! return the size of the identity matrix
  inline uint_4 Size() { return size_; }
  //! return the value of the diagonal elements
  inline double Diag() { return diag_; }
protected:
  uint_4 size_; //!< size of the matrix
  double diag_; //!< value of the diagonal elements
};

} // Fin du namespace

#endif