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

List of all members.

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.

---

Detailed Description

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

A base class for scalar parameter values.

Definition at line 89 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

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

Definition at line 93 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 96 of file Sacado_ScalarParameterEntry.hpp.

template<typename EvalType, typename EvalTypeTraits = DefaultEvalTypeTraits>

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

(

)

[inline, virtual]

Destructor.

Definition at line 99 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 [inline, virtual]

Get real parameter value.

Default implementation should work in most cases.

Implements Sacado::AbstractScalarParameterEntry.

Definition at line 115 of file Sacado_ScalarParameterEntry.hpp.

template<typename EvalType, typename EvalTypeTraits = DefaultEvalTypeTraits>

virtual void Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >::print

(

std::ostream &

os

)

const [inline, virtual]

Print entry.

Default implementation should work in most cases.

Implements Sacado::AbstractScalarParameterEntry.

Definition at line 123 of file Sacado_ScalarParameterEntry.hpp.

---

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

• Sacado_ScalarParameterEntry.hpp