ConjugateGradientOptions Class Reference

#include <ConjugateGradientOptions.hpp>

Inheritance diagram for ConjugateGradientOptions:

[legend]

Collaboration diagram for ConjugateGradientOptions:

[legend]

List of all members.

Public Member Functions
real_t	epsilon ()
int	maxiter ()
	ConjugateGradientOptions ()
	~ConjugateGradientOptions ()
void	get (IdentifierSet &I)
const ReferenceCounting < Parameter >	get (const char *parameterName) const
void	reset ()
Static Public Member Functions
static const char *	identifier ()
Protected Member Functions
template<typename EnumType>
void	get (const char *label, EnumType &e) const
void	get (const char *label, real_t &d) const
void	get (const char *label, int &i) const
void	get (const char *label, std::string &s) const
void	add (ReferenceCounting< Parameter > p)
Private Member Functions
std::ostream &	put (std::ostream &os) const
Friends
std::ostream &	operator<< (std::ostream &os, const ParametrizableObject &P)
	Writes the ParametrizableObject.

---

Detailed Description

Definition at line 25 of file ConjugateGradientOptions.hpp.

---

Constructor & Destructor Documentation

ConjugateGradientOptions::ConjugateGradientOptions

(

)

[inline, explicit]

Definition at line 56 of file ConjugateGradientOptions.hpp.

  {
    // autodoc: "sets maximum number of iteration"
    add(new IntegerParameter(500, "maxiter"));
    // autodoc: "sets the required reduction factor of the residu"
    add(new DoubleParameter (1E-5,"epsilon"));
  }

ConjugateGradientOptions::~ConjugateGradientOptions

(

)

[inline]

Definition at line 64 of file ConjugateGradientOptions.hpp.

  {
    ;
  }

---

Member Function Documentation

std::ostream& ConjugateGradientOptions::put

(

std::ostream &

os

)

const [inline, private, virtual]

Implements ParametrizableObject.

Definition at line 29 of file ConjugateGradientOptions.hpp.

References identifier().

  {
    os << this->identifier();
    return os;
  }

Here is the call graph for this function:

static const char* ConjugateGradientOptions::identifier

(

)

[inline, static]

Definition at line 36 of file ConjugateGradientOptions.hpp.

Referenced by put().

  {
    // autodoc: "specifies conjugate gradient options"
    return "cg";
  }

real_t ConjugateGradientOptions::epsilon

(

)

[inline]

Definition at line 42 of file ConjugateGradientOptions.hpp.

Referenced by ConjugateGradient::ConjugateGradient().

  {
    real_t eps = 0;
    get("epsilon",eps);
    return eps;
  }

int ConjugateGradientOptions::maxiter

(

)

[inline]

Definition at line 49 of file ConjugateGradientOptions.hpp.

Referenced by ConjugateGradient::ConjugateGradient().

  {
    int maxiter = 0;
    get("maxiter",maxiter);
    return maxiter;
  }

void ParametrizableObject::get

(

IdentifierSet &

I

)

[inline, inherited]

Definition at line 54 of file ParametrizableObject.hpp.

References ParametrizableObject::__parameters.

  {
    for (ParameterList::iterator i = __parameters.begin();
         i != __parameters.end(); ++i)
      {
        (*(*i).second).get(I);
        I.insert((*i).first);
      }
  }

template<typename EnumType>

void ParametrizableObject::get	(	const char *	label,
		EnumType &	e
	)			const [inline, protected, inherited]

Definition at line 71 of file ParametrizableObject.hpp.

References Parameter::Enum.

  {
    ReferenceCounting<Parameter> p = get(label);
    if((*p).type() == Parameter::Enum) {
      e = dynamic_cast<const EnumParameter<EnumType>&>(*p);
      return;
    }
  }

void ParametrizableObject::get	(	const char *	label,
		real_t &	d
	)			const [inline, protected, inherited]

Definition at line 80 of file ParametrizableObject.hpp.

References Parameter::Double.

  {
    ReferenceCounting<Parameter> p = get(label);
    if((*p).type() == Parameter::Double) {
      d = dynamic_cast<const DoubleParameter&>(*p);
      return;
    }      
  }

void ParametrizableObject::get	(	const char *	label,
		int &	i
	)			const [inline, protected, inherited]

Definition at line 89 of file ParametrizableObject.hpp.

References Parameter::Integer.

  {
    ReferenceCounting<Parameter> p = get(label);
    if((*p).type() == Parameter::Integer) {
      i = dynamic_cast<const IntegerParameter&>(*p);
      return;
    }      
  }

void ParametrizableObject::get	(	const char *	label,
		std::string &	s
	)			const [inline, protected, inherited]

Definition at line 98 of file ParametrizableObject.hpp.

References Parameter::String.

  {
    ReferenceCounting<Parameter> p = get(label);
    if((*p).type() == Parameter::String) {
      s = dynamic_cast<const StringParameter&>(*p);
      return;
    }      
  }

const ReferenceCounting<Parameter> ParametrizableObject::get

(

const char *

parameterName

)

const [inline, inherited]

Definition at line 117 of file ParametrizableObject.hpp.

References ParametrizableObject::__parameters, ErrorHandler::normal, and stringify().

  {
    ParameterList::const_iterator i = __parameters.find(parameterName);
    if (i != __parameters.end()) {
      return (*i).second;
    } else {
      throw ErrorHandler(__FILE__,__LINE__,
                         stringify(parameterName)+" not found",
                         ErrorHandler::normal);
      return 0;
    }
  }

Here is the call graph for this function:

void ParametrizableObject::add

(

ReferenceCounting< Parameter >

p

)

[inline, protected, inherited]

Definition at line 65 of file ParametrizableObject.hpp.

References ParametrizableObject::__parameters.

  {
    __parameters[(*p).label()] = p;
  }

void ParametrizableObject::reset

(

)

[inline, inherited]

Definition at line 109 of file ParametrizableObject.hpp.

References ParametrizableObject::__parameters.

  {
    for (ParameterList::iterator i = __parameters.begin();
         i != __parameters.end(); ++i) {
      (*(*i).second).reset();
    }
  }

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const ParametrizableObject &	P
	)			[friend, inherited]

Writes the ParametrizableObject.

Definition at line 22 of file ParametrizableObject.cpp.

{
  os  << P.put(os);
  return os;
}

---

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

• ConjugateGradientOptions.hpp