QuantLib: a free/open-source library for quantitative finance
fully annotated source code - version 1.34
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Parameter Class Reference

Base class for model arguments. More...

#include <parameter.hpp>

+ Inheritance diagram for Parameter:
+ Collaboration diagram for Parameter:

Classes

class  Impl
 Base class for model parameter implementation. More...
 

Public Member Functions

 Parameter ()
 
const Arrayparams () const
 
void setParam (Size i, Real x)
 
bool testParams (const Array &params) const
 
Size size () const
 
Real operator() (Time t) const
 
const ext::shared_ptr< Impl > & implementation () const
 
const Constraintconstraint () const
 

Protected Member Functions

 Parameter (Size size, ext::shared_ptr< Impl > impl, Constraint constraint)
 

Protected Attributes

ext::shared_ptr< Implimpl_
 
Array params_
 
Constraint constraint_
 

Detailed Description

Base class for model arguments.

Definition at line 38 of file parameter.hpp.

Constructor & Destructor Documentation

◆ Parameter() [1/2]

Parameter ( )

Definition at line 48 of file parameter.hpp.

◆ Parameter() [2/2]

Parameter ( Size  size,
ext::shared_ptr< Impl impl,
Constraint  constraint 
)
protected

Definition at line 64 of file parameter.hpp.

Member Function Documentation

◆ params()

const Array & params ( ) const

Definition at line 50 of file parameter.hpp.

+ Here is the caller graph for this function:

◆ setParam()

void setParam ( Size  i,
Real  x 
)

Definition at line 51 of file parameter.hpp.

+ Here is the caller graph for this function:

◆ testParams()

bool testParams ( const Array params) const

Definition at line 52 of file parameter.hpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ size()

Size size ( ) const

Definition at line 55 of file parameter.hpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator()()

Real operator() ( Time  t) const

Definition at line 56 of file parameter.hpp.

◆ implementation()

const ext::shared_ptr< Impl > & implementation ( ) const

Definition at line 59 of file parameter.hpp.

+ Here is the caller graph for this function:

◆ constraint()

const Constraint & constraint ( ) const

Definition at line 62 of file parameter.hpp.

Member Data Documentation

◆ impl_

ext::shared_ptr<Impl> impl_
protected

Definition at line 46 of file parameter.hpp.

◆ params_

Array params_
protected

Definition at line 66 of file parameter.hpp.

◆ constraint_

Constraint constraint_
protected

Definition at line 67 of file parameter.hpp.