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 >:

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

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

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

Detailed Description

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

A base class for scalar parameter values.

Member Function Documentation

getRealValue()

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.

References getValue().

getValue()

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 >.

Referenced by getRealValue(), and print().

print()

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.

References getValue().

setValue()

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).

---

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

• Sacado_ScalarParameterEntry.hpp