JOSCPROB::JComplexPhase< JGrid< double > > Struct Template Reference

Template specialization for parameter grid. More...

#include <JComplexPhase.hh>

Inheritance diagram for JOSCPROB::JComplexPhase< JGrid< double > >:

Public Types
typedef JGrid< double >	JGrid_t
typedef JComplexPhase< JGrid_t >	JComplexPhase_t
typedef JOscParameter< JGrid_t >	JOscParameter_t
typedef JOscParameter_t::JParameter_t	JParameter_t
typedef JOscParameter_t::argument_type	argument_type
typedef JGrid_t::abscissa_type	abscissa_type

Public Member Functions
	JComplexPhase ()
	Default constructor. More...
	JComplexPhase (argument_type grid)
	Constructor. More...
	JComplexPhase (const int nx, const abscissa_type &xmin, const abscissa_type &xmax)
	Constructor. More...
	JComplexPhase (const abscissa_type &value)
	Constructor. More...
JComplexPhase_t &	operator= (argument_type grid)
	Assignment operator. More...
bool	is_valid () const override
	Check validity of oscillation parameter. More...
void	setValue (argument_type value)
	Set parameter. More...
const T &	getValue () const
	Get value of parameter. More...
T &	getValue ()
	Get value of parameter. More...
	operator const T & () const
	Type conversion operator. More...
	operator T & ()
	Type conversion operator. More...
const bool	isDefined () const
	Get status of parameter. More...
bool	less (const JParameter< T > &parameter) const
	Less than method. More...

Static Public Member Functions
static JComplexPhase_t	make_parameter (const abscissa_type &value)
	Auxiliary function to create a complex phase parameter grid. More...

Protected Attributes
T	__value
bool	is_defined

Detailed Description

template<>
struct JOSCPROB::JComplexPhase< JGrid< double > >

Template specialization for parameter grid.

Definition at line 105 of file JComplexPhase.hh.

Member Typedef Documentation

typedef JGrid<double> JOSCPROB::JComplexPhase< JGrid< double > >::JGrid_t

Definition at line 108 of file JComplexPhase.hh.

typedef JComplexPhase<JGrid_t> JOSCPROB::JComplexPhase< JGrid< double > >::JComplexPhase_t

Definition at line 109 of file JComplexPhase.hh.

typedef JOscParameter<JGrid_t> JOSCPROB::JComplexPhase< JGrid< double > >::JOscParameter_t

Definition at line 110 of file JComplexPhase.hh.

typedef JOscParameter_t::JParameter_t JOSCPROB::JComplexPhase< JGrid< double > >::JParameter_t

Definition at line 112 of file JComplexPhase.hh.

typedef JOscParameter_t::argument_type JOSCPROB::JComplexPhase< JGrid< double > >::argument_type

Definition at line 113 of file JComplexPhase.hh.

typedef JGrid_t::abscissa_type JOSCPROB::JComplexPhase< JGrid< double > >::abscissa_type

Definition at line 115 of file JComplexPhase.hh.

Constructor & Destructor Documentation

JOSCPROB::JComplexPhase< JGrid< double > >::JComplexPhase ( )

inline

Default constructor.

Definition at line 121 of file JComplexPhase.hh.

    {}

JOSCPROB::JComplexPhase< JGrid< double > >::JComplexPhase ( argument_type  grid )

inlineexplicit

Constructor.

Parameters

grid	complex phase parameter grid [rad]

Definition at line 130 of file JComplexPhase.hh.

                                               :
      JOscParameter_t(grid)
    {
      using namespace JPP;
      
      if (!is_valid()) {
        THROW(JValueOutOfRange, "JComplexPhase::JComplexPhase(): Invalid complex phase grid " << grid);
      }
    }

JOSCPROB::JComplexPhase< JGrid< double > >::JComplexPhase ( const int  nx, const abscissa_type &  xmin, const abscissa_type &  xmax  )

inline

Constructor.

Parameters

nx	number of elements
xmin	lower limit [rad]
xmax	upper limit [rad]

Definition at line 148 of file JComplexPhase.hh.

                                             :
      JOscParameter_t(JGrid_t(nx, xmin, xmax))
    {}

JOSCPROB::JComplexPhase< JGrid< double > >::JComplexPhase ( const abscissa_type &  value )

inlineexplicit

Constructor.

Parameters

value

complex phase value [rad]

Definition at line 160 of file JComplexPhase.hh.

                                                       :
      JComplexPhase(1, value, value)
    {}

Member Function Documentation

JComplexPhase_t& JOSCPROB::JComplexPhase< JGrid< double > >::operator= ( argument_type  grid )

inline

Assignment operator.

Parameters

grid	complex phase parameter grid [rad]

Returns

complex phase

Definition at line 171 of file JComplexPhase.hh.

    {
      this->setValue(grid);

      return *this;
    }

bool JOSCPROB::JComplexPhase< JGrid< double > >::is_valid ( ) const

inlineoverridevirtual

Check validity of oscillation parameter.

Returns

true if valid; else false

Implements JOSCPROB::JOscParameter< JGrid< double > >.

Definition at line 184 of file JComplexPhase.hh.

    {
      const abscissa_type minPhase = this->getValue().getXmin();
      const abscissa_type maxPhase = this->getValue().getXmax();      
      
      return (this->isDefined() ? !(minPhase < 0.0 || minPhase > 2 * M_PI ||
                                    maxPhase < 0.0 || maxPhase > 2 * M_PI) : true);
    }

static JComplexPhase_t JOSCPROB::JComplexPhase< JGrid< double > >::make_parameter ( const abscissa_type &  value )

inlinestatic

Auxiliary function to create a complex phase parameter grid.

Parameters

value

complex phase value [rad]

Returns

complex phase parameter

Definition at line 200 of file JComplexPhase.hh.

    {
      return JComplexPhase_t(value);
    }

void JOSCPROB::JOscParameter< JGrid< double > >::setValue ( argument_type  value )

inlineinherited

Set parameter.

Parameters

value

oscillation parameter value

Definition at line 73 of file JOscParameter.hh.

    {
      using namespace JPP;

      JParameter_t::setValue(value);

      if (!this->is_valid()) {
        THROW(JValueOutOfRange, "JOscParameter<T>::setValue(): Given oscillation parameter is invalid " << value);
      }
    }

template<class T>

const T& JLANG::JParameter< T >::getValue ( ) const

inlineinherited

Get value of parameter.

Returns

value

Definition at line 81 of file JParameter.hh.

    { 
      return __value; 
    }

template<class T>

T& JLANG::JParameter< T >::getValue ( )

inlineinherited

Get value of parameter.

Returns

value

Definition at line 92 of file JParameter.hh.

    { 
      return __value; 
    }

template<class T>

JLANG::JParameter< T >::operator const T & ( ) const

inlineinherited

Type conversion operator.

Returns

value

Definition at line 115 of file JParameter.hh.

    { 
      return getValue();
    }

template<class T>

JLANG::JParameter< T >::operator T & ( )

inlineinherited

Type conversion operator.

Returns

value

Definition at line 126 of file JParameter.hh.

    {
      return getValue();
    }

template<class T>

const bool JLANG::JParameter< T >::isDefined ( ) const

inlineinherited

Get status of parameter.

Returns

true if value has been defined (by read or assignment); else false

Definition at line 137 of file JParameter.hh.

    {
      return is_defined;
    }

template<class T>

bool JLANG::JParameter< T >::less ( const JParameter< T > &  parameter ) const

inlineinherited

Less than method.

This method evaluates to true if both parameter values are defined and this value is less than the value of the given parameter object.

Parameters

parameter

parameter

Returns

true if both defined and first value less than second value; else false

Definition at line 152 of file JParameter.hh.

    {
      return this->isDefined() && parameter.isDefined() && this->getValue() < parameter.getValue();
    }

Member Data Documentation

template<class T>

T JLANG::JParameter< T >::__value

protectedinherited

Definition at line 193 of file JParameter.hh.

template<class T>

bool JLANG::JParameter< T >::is_defined

protectedinherited

Definition at line 194 of file JParameter.hh.

---

The documentation for this struct was generated from the following file:

• JComplexPhase.hh