Sacado::ScalarParameterFamily Class Reference

Specialization of Sacado::ParameterFamilyBase for scalar parameters. More...

#include <Sacado_ScalarParameterFamily.hpp>

Inheritance diagram for Sacado::ScalarParameterFamily:

[legend]List of all members.

Public Member Functions
	ScalarParameterFamily (const std::string &name, bool supports_ad, bool supports_analytic)
	Constructor.
virtual	~ScalarParameterFamily ()
	Destructor.
void	setRealValueForAllTypes (double value)
	Set paramter value using a real number.
template<class ValueType>
void	setValueAsConstant (const ValueType &value)
	Set parameter to value value treating parameter as a constant.
template<class ValueType>
void	setValueAsIndependent (const ValueType &value)
	Set parameter to value value treating parameter as an independent.
template<class ValueType>
const ValueType &	getValue () const
	Get parameter value.
Private Types
typedef Sacado::ParameterFamilyBase< Sacado::AbstractScalarParameterEntry, Sacado::ScalarParameterEntry >	BaseT
	Typename synonym of base class.
Private Member Functions
	ScalarParameterFamily (const ScalarParameterFamily &)
	Private to prohibit copying.
ScalarParameterFamily &	operator= (const ScalarParameterFamily &)
	Private to prohibit copying.
Related Functions
(Note that these are not member functions.)
template<class ValueType>
ValueType	getValue (const ScalarParameterFamily &spf)
	Get the value.

---

Detailed Description

Specialization of Sacado::ParameterFamilyBase for scalar parameters.

Definition at line 41 of file Sacado_ScalarParameterFamily.hpp.

---

Member Typedef Documentation

typedef Sacado::ParameterFamilyBase<Sacado::AbstractScalarParameterEntry, Sacado::ScalarParameterEntry> Sacado::ScalarParameterFamily::BaseT [private]

Typename synonym of base class.

Definition at line 48 of file Sacado_ScalarParameterFamily.hpp.

---

Constructor & Destructor Documentation

Sacado::ScalarParameterFamily::ScalarParameterFamily	(	const std::string &	name,
		bool	supports_ad,
		bool	supports_analytic
	)			[inline]

Constructor.

Definition at line 53 of file Sacado_ScalarParameterFamily.hpp.

virtual Sacado::ScalarParameterFamily::~ScalarParameterFamily

(

)

[inline, virtual]

Destructor.

Definition at line 60 of file Sacado_ScalarParameterFamily.hpp.

Sacado::ScalarParameterFamily::ScalarParameterFamily

(

const ScalarParameterFamily &

)

[private]

Private to prohibit copying.

---

Member Function Documentation

void Sacado::ScalarParameterFamily::setRealValueForAllTypes

(

double

value

)

[inline]

Set paramter value using a real number.

Definition at line 63 of file Sacado_ScalarParameterFamily.hpp.

template<class ValueType>

void Sacado::ScalarParameterFamily::setValueAsConstant

(

const ValueType &

value

)

[inline]

Set parameter to value value treating parameter as a constant.

Definition at line 70 of file Sacado_ScalarParameterFamily.hpp.

template<class ValueType>

void Sacado::ScalarParameterFamily::setValueAsIndependent

(

const ValueType &

value

)

[inline]

Set parameter to value value treating parameter as an independent.

Definition at line 76 of file Sacado_ScalarParameterFamily.hpp.

template<class ValueType>

const ValueType& Sacado::ScalarParameterFamily::getValue

(

)

const [inline]

Get parameter value.

Definition at line 82 of file Sacado_ScalarParameterFamily.hpp.

ScalarParameterFamily& Sacado::ScalarParameterFamily::operator=

(

const ScalarParameterFamily &

)

[private]

Private to prohibit copying.

---

Friends And Related Function Documentation

template<class ValueType>

ValueType getValue

(

const ScalarParameterFamily &

spf

)

[related]

Get the value.

Definition at line 101 of file Sacado_ScalarParameterFamily.hpp.

---

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

• Sacado_ScalarParameterFamily.hpp

---