Jpp 19.3.0-rc.2
the software that should make you happy
Loading...
Searching...
No Matches
JOSCPROB::JComplexPhase< JGrid< double > > Struct Referencefinal

Template specialization for parameter grid. More...

#include <JComplexPhase.hh>

Inheritance diagram for JOSCPROB::JComplexPhase< JGrid< double > >:
JOSCPROB::JOscParameter< JGrid< double > > JLANG::JParameter< T > JLANG::JComparable< JParameter< T > >

Public Types

typedef JGrid< double > JGrid_t
 
typedef JComplexPhase< JGrid_tJComplexPhase_t
 
typedef JOscParameter< JGrid_tJOscParameter_t
 
typedef JOscParameter_t::JParameter_t JParameter_t
 
typedef JParameter_t::argument_type argument_type
 
typedef JParameter_t::value_type value_type
 

Public Member Functions

 JComplexPhase ()
 Default constructor.
 
 JComplexPhase (const JGrid_t &grid)
 Constructor.
 
 JComplexPhase (const int nx, const double xmin, const double xmax)
 Constructor.
 
 JComplexPhase (const double value)
 Constructor.
 
JComplexPhase_toperator= (const JGrid_t &grid)
 Assignment operator.
 
bool is_valid () const override final
 Check validity of oscillation parameter.
 
void setValue (const value_type &value)
 Set parameter.
 
const value_type getValue () const
 Get value of parameter.
 
 operator const value_type () const
 Type conversion operator.
 
const bool isDefined () const
 Get status of parameter.
 
bool less (const JParameter< T > &parameter) const
 Less than method.
 

Protected Attributes

__value
 
bool is_defined
 

Detailed Description

Template specialization for parameter grid.

Definition at line 94 of file JComplexPhase.hh.

Member Typedef Documentation

◆ JGrid_t

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

Definition at line 97 of file JComplexPhase.hh.

◆ JComplexPhase_t

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

Definition at line 98 of file JComplexPhase.hh.

◆ JOscParameter_t

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

Definition at line 99 of file JComplexPhase.hh.

◆ JParameter_t

Definition at line 101 of file JComplexPhase.hh.

◆ argument_type

JParameter_t::argument_type JOSCPROB::JOscParameter< JGrid< double > >::argument_type
inherited

Definition at line 33 of file JOscParameter.hh.

◆ value_type

JParameter_t::value_type JOSCPROB::JOscParameter< JGrid< double > >::value_type
inherited

Definition at line 34 of file JOscParameter.hh.

Constructor & Destructor Documentation

◆ JComplexPhase() [1/4]

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

Default constructor.

Definition at line 107 of file JComplexPhase.hh.

108 {}

◆ JComplexPhase() [2/4]

JOSCPROB::JComplexPhase< JGrid< double > >::JComplexPhase ( const JGrid_t & grid)
inlineexplicit

Constructor.

Parameters
gridcomplex phase parameter grid [rad]

Definition at line 116 of file JComplexPhase.hh.

116 :
117 JOscParameter_t(grid)
118 {
119 using namespace JPP;
120
121 if (!is_valid()) {
122 THROW(JValueOutOfRange, "JComplexPhase::JComplexPhase(): Invalid complex phase grid " << grid);
123 }
124 }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Exception for accessing a value in a collection that is outside of its range.
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
bool is_valid() const override final
Check validity of oscillation parameter.

◆ JComplexPhase() [3/4]

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

Constructor.

Parameters
nxnumber of elements
xminlower limit [rad]
xmaxupper limit [rad]

Definition at line 134 of file JComplexPhase.hh.

136 :
137 JOscParameter_t(JGrid_t(nx, xmin, xmax))
138 {}

◆ JComplexPhase() [4/4]

JOSCPROB::JComplexPhase< JGrid< double > >::JComplexPhase ( const double value)
inlineexplicit

Constructor.

Parameters
valuecomplex phase value [rad]

Definition at line 146 of file JComplexPhase.hh.

146 :
147 JComplexPhase(1, value, value)
148 {}

Member Function Documentation

◆ operator=()

JComplexPhase_t & JOSCPROB::JComplexPhase< JGrid< double > >::operator= ( const JGrid_t & grid)
inline

Assignment operator.

Parameters
gridcomplex phase parameter grid [rad]
Returns
complex phase

Definition at line 157 of file JComplexPhase.hh.

158 {
159 this->setValue(grid);
160
161 return *this;
162 }
void setValue(const value_type &value)

◆ is_valid()

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

Check validity of oscillation parameter.

Returns
true if valid; else false

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

Definition at line 170 of file JComplexPhase.hh.

171 {
172 const double minPhase = this->getValue().getXmin();
173 const double maxPhase = this->getValue().getXmax();
174
175 return (this->isDefined() ? !(minPhase < 0.0 || minPhase > 2 * M_PI ||
176 maxPhase < 0.0 || maxPhase > 2 * M_PI) : true);
177 }
const value_type getValue() const
Get value of parameter.
Definition JParameter.hh:82
const bool isDefined() const
Get status of parameter.

◆ setValue()

void JOSCPROB::JOscParameter< JGrid< double > >::setValue ( const value_type & value)
inlineinherited

Set parameter.

Parameters
valueoscillation parameter value

Definition at line 74 of file JOscParameter.hh.

75 {
76 using namespace JPP;
77
79
80 if (!this->is_valid()) {
81 THROW(JValueOutOfRange, "JOscParameter<T>::setValue(): Given oscillation parameter is invalid " << value);
82 }
83 }
void setValue(const value_type &value)
Set value.
Definition JParameter.hh:93

◆ getValue()

template<class T >
const value_type JLANG::JParameter< T >::getValue ( ) const
inlineinherited

Get value of parameter.

Returns
value

Definition at line 82 of file JParameter.hh.

83 {
84 return __value;
85 }

◆ operator const value_type()

template<class T >
JLANG::JParameter< T >::operator const value_type ( ) const
inlineinherited

Type conversion operator.

Returns
value

Definition at line 105 of file JParameter.hh.

106 {
107 return getValue();
108 }

◆ isDefined()

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 116 of file JParameter.hh.

117 {
118 return is_defined;
119 }

◆ less()

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
parameterparameter
Returns
true if both defined and first value less than second value; else false

Definition at line 131 of file JParameter.hh.

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

Member Data Documentation

◆ __value

template<class T >
T JLANG::JParameter< T >::__value
protectedinherited

Definition at line 172 of file JParameter.hh.

◆ is_defined

template<class T >
bool JLANG::JParameter< T >::is_defined
protectedinherited

Definition at line 173 of file JParameter.hh.


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