ScalarMath.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2004 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/MEAL/MEAL/ScalarMath.h
 
#ifndef __ScalarMath_H
#define __ScalarMath_H
 
#include "MEAL/Scalar.h"
 
namespace MEAL {

  class ScalarMath {
 
  public:

    ScalarMath (double value = 0.0);

    explicit ScalarMath (const Estimate<double>& value);

    ScalarMath (const ScalarMath& s);

    ScalarMath (const Reference::To<Scalar>& s);

    ScalarMath (Scalar& s);

    const ScalarMath operator = (const ScalarMath& s);

    const ScalarMath operator += (const ScalarMath& b);

    const ScalarMath operator -= (const ScalarMath& b);
    
    const ScalarMath operator *= (const ScalarMath& b);
    
    const ScalarMath operator /= (const ScalarMath& b);

    double evaluate () const;

    Estimate<double> get_Estimate () const;

    Scalar* get_expression () const { return expression; }
 
  protected:

    Reference::To<Scalar> expression;
 
  };

  const ScalarMath operator - (const ScalarMath& b);

  const ScalarMath operator + (const ScalarMath& b);

  const ScalarMath operator + (const ScalarMath& a, const ScalarMath& b);

  const ScalarMath operator - (const ScalarMath& a, const ScalarMath& b);

  const ScalarMath operator * (const ScalarMath& a, const ScalarMath& b);
    
  const ScalarMath operator / (const ScalarMath& a, const ScalarMath& b);

  bool operator == (const ScalarMath& a, const ScalarMath& b);

  bool operator != (const ScalarMath& a, const ScalarMath& b);

  bool operator < (const ScalarMath& a, const ScalarMath& b);

  bool operator > (const ScalarMath& a, const ScalarMath& b);

  bool operator <= (const ScalarMath&, const ScalarMath&);

  bool operator >= (const ScalarMath&, const ScalarMath&);

  const ScalarMath pow (const ScalarMath& x, const ScalarMath& y);

  const ScalarMath sqrt (const ScalarMath& x);

  const ScalarMath abs (const ScalarMath& x);

  const ScalarMath sin (const ScalarMath& x);

  const ScalarMath cos (const ScalarMath& x);

  const ScalarMath tan (const ScalarMath& x);

  const ScalarMath sinh (const ScalarMath& x);
  
  const ScalarMath cosh (const ScalarMath& x);

  const ScalarMath tanh (const ScalarMath& x);

  const ScalarMath erf (const ScalarMath& x);

  const ScalarMath exp (const ScalarMath& x);

  const ScalarMath log (const ScalarMath& x);

  const ScalarMath atanh (const ScalarMath& x);

  const ScalarMath atan (const ScalarMath& x);

  const ScalarMath atan2 (const ScalarMath& y, const ScalarMath& x);

  inline std::ostream&
  operator << (std::ostream& o, const ScalarMath& sm)
  {
    return o << sm.get_Estimate();
  }
}
 
#endif