Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits > Class Template Reference

A base class for scalar parameter values. More...

#include <Sacado_ScalarParameterEntry.hpp>

Inheritance diagram for Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >:

Public Types
typedef EvalTypeTraits::template apply < EvalType >::type	ScalarT

Public Member Functions
	ScalarParameterEntry ()
	Default constructor. More...
virtual	~ScalarParameterEntry ()
	Destructor. More...
virtual void	setValue (const ScalarT &value)=0
	Set parameter this object represents to value. More...
virtual const ScalarT &	getValue () const =0
	Get parameter value this object represents. More...
virtual double	getRealValue () const
	Get real parameter value. More...
virtual void	print (std::ostream &os) const
	Print entry. More...
Public Member Functions inherited from Sacado::AbstractScalarParameterEntry
	AbstractScalarParameterEntry ()
	Default contructor. More...
virtual	~AbstractScalarParameterEntry ()
	Destructor. More...
virtual void	setRealValue (double value)=0
	Set real parameter value. More...

Detailed Description

template<typename EvalType, typename EvalTypeTraits = DefaultEvalTypeTraits>
class Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >

A base class for scalar parameter values.

Definition at line 67 of file Sacado_ScalarParameterEntry.hpp.

Member Typedef Documentation

template<typename EvalType, typename EvalTypeTraits = DefaultEvalTypeTraits>

typedef EvalTypeTraits::template apply<EvalType>::type Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >::ScalarT

Definition at line 71 of file Sacado_ScalarParameterEntry.hpp.

Constructor & Destructor Documentation

template<typename EvalType, typename EvalTypeTraits = DefaultEvalTypeTraits>

Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >::ScalarParameterEntry ( )

inline

Default constructor.

Definition at line 74 of file Sacado_ScalarParameterEntry.hpp.

template<typename EvalType, typename EvalTypeTraits = DefaultEvalTypeTraits>

virtual Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >::~ScalarParameterEntry ( )

inlinevirtual

Destructor.

Definition at line 77 of file Sacado_ScalarParameterEntry.hpp.

Member Function Documentation

template<typename EvalType, typename EvalTypeTraits = DefaultEvalTypeTraits>

virtual void Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >::setValue ( const ScalarT &  value )

pure virtual

Set parameter this object represents to value.

Treat the set parameter as an independent for derivative computations (use setRealValue() otherwise).

Implemented in Sacado::ParameterRegistration< EvalType, EvalTypeTraits >.

template<typename EvalType, typename EvalTypeTraits = DefaultEvalTypeTraits>

virtual const ScalarT& Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >::getValue ( ) const

pure virtual

Get parameter value this object represents.

Implemented in Sacado::ParameterRegistration< EvalType, EvalTypeTraits >.

template<typename EvalType, typename EvalTypeTraits = DefaultEvalTypeTraits>

virtual double Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >::getRealValue ( ) const

inlinevirtual

Get real parameter value.

Default implementation should work in most cases.

Implements Sacado::AbstractScalarParameterEntry.

Definition at line 93 of file Sacado_ScalarParameterEntry.hpp.

template<typename EvalType, typename EvalTypeTraits = DefaultEvalTypeTraits>

virtual void Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >::print ( std::ostream &  os ) const

inlinevirtual

Print entry.

Default implementation should work in most cases.

Implements Sacado::AbstractScalarParameterEntry.

Definition at line 101 of file Sacado_ScalarParameterEntry.hpp.

---

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

• Sacado_ScalarParameterEntry.hpp