Class xlifepp::Parameter#

class Parameter#

Collaboration diagram for xlifepp::Parameter:

encapsulates any scalar value of type int, real_t, complex_t, string_t or const void*.

main standard algebric operations are supported for parameter of numerical type
const void* allows to store anything; it is designed for advanced users because void pointers are unsafe particular pointers are managed by class: std::vector<real_t>* to store some reals std::vector<complex_t>* to store some complexes std::vector<int_t>* to store some integers std::vector<string_t>* to store some strings Matrix<real_t>* to store a real matrix Matrix<complex_t>* to store a complex matrix Point* to store a point std::vector<Point>* to store some points

Public Functions

Parameter()#: default constructor

Parameter(const bool b, const string_t &nm, const Strings &snm)#: constructor from a bool

Parameter(const bool b, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a bool

Parameter(const char *s, const string_t &nm, const Strings &snm)#: constructor from a char array

Parameter(const char *s, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a char array

Parameter(const complex_t &c, const string_t &nm, const Strings &snm)#: constructor from a complex_t

Parameter(const complex_t &c, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a complex_t

explicit Parameter(const Function &fct, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a Function (defined in Function.cpp)

explicit Parameter(const GeomDomain &dom, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#

constructor from a Spline

constructor from a GeomDomain (defined in GeomDomain.cpp)

Parameter(const int i, const string_t &nm, const Strings &snm)#: constructor from an int

Parameter(const int i, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from an int

Parameter(const int_t i, const string_t &nm, const Strings &snm)#: constructor from an int_t

Parameter(const int_t i, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from an int_t

explicit Parameter(const IntegrationMethod &im, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a IntegrationMethod (defined in IntegrationMethod.cpp)

explicit Parameter(const IntegrationMethods &ims, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a IntegrationMethod (defined in IntegrationMethod.cpp)

explicit Parameter(const Matrix<complex_t> &cm, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a Matrix<complex_t>

explicit Parameter(const Matrix<real_t> &rm, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a Matrix<real_t>

Parameter(const number_t i, const string_t &nm, const Strings &snm)#: constructor from a number_t

Parameter(const number_t i, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a number_t

Parameter(const Parameter &p, const string_t &nm, const Strings &snm)#: copy constructor with optional arg name

Parameter(const Parameter &p, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: copy constructor with optional arg name

explicit Parameter(const Parametrization &par, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a Parametrization (defined in Parametrization.cpp)

explicit Parameter(const Point &p, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a Point

Parameter(const real_t r, const string_t &nm, const Strings &snm)#: constructor from a real_t

Parameter(const real_t r, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a real_t

explicit Parameter(const std::vector<bool> &bv, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a std::vector<bool>

explicit Parameter(const std::vector<complex_t> &cv, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a std::vector<complex_t>

explicit Parameter(const std::vector<int_t> &iv, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a std::vector<int_t>

explicit Parameter(const std::vector<number_t> &nv, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a std::vector<number_t>

explicit Parameter(const std::vector<Point> &pv, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a vector of Point

explicit Parameter(const std::vector<real_t> &rv, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a std::vector<real_t>

explicit Parameter(const std::vector<string_t> &sv, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a std::vector<string_t>

Parameter(const string_t &s, const string_t &nm, const Strings &snm)#: constructor from a string_t

Parameter(const string_t &s, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a string_t

explicit Parameter(const TermVectors &tvs, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a TermVectors (defined in TermVector.cpp)

Parameter(const void *p, const string_t &nm, const Strings &snm)#: constructor from a const void*

Parameter(const void *p, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#: constructor from a const void*

Parameter(ParameterKey key, const string_t &nm, const Strings &snm)#

constructor from key

default constructor

Parameter(ParameterKey key, const string_t &nm = string_t(""), const string_t &snm = string_t(""))#

constructor from key

default constructor

inline ~Parameter()#: parameter destructor

void deletePointer()#

delete pointer if type is a vector or a matrix

delete pointer if type is a vector, a matrix, ….

inline bool get_b() const#: get parameter bool value

inline const std::vector<bool> &get_bv() const#: get parameter as std::vector<bool>

inline complex_t get_c() const#: get parameter complex value

inline const Matrix<complex_t> &get_cm() const#: get parameter as Matrix<complex_t>

inline const std::vector<complex_t> &get_cv() const#: get parameter as std::vector<complex_t>

inline number_t get_d() const#: get parameter as dimen_t value

inline int_t get_i() const#: get parameter int_t value

inline const std::vector<int_t> &get_iv() const#: get parameter as std::vector<int_t>

inline number_t get_n() const#: get parameter as number_t value

inline std::vector<number_t> get_nv() const#: get parameter as std::vector<number_t>

inline const void *get_p() const#: get parameter const void* value

inline const Point &get_pt() const#: get parameter as Point

inline const std::vector<Point> &get_ptv() const#: get parameter as Point

inline real_t get_r() const#: get parameter real value

inline const Matrix<real_t> &get_rm() const#: get parameter as Matrix<real_t>

inline const std::vector<real_t> &get_rv() const#: get parameter as std::vector<real_t>

inline string_t get_s() const#: get parameter string_t value

inline const std::vector<string_t> &get_sv() const#: get parameter as std::vector<string_t>

void illegalOperation(const string_t &t1, const string_t &op, const string_t &t2) const#: error handlers

inline ParameterKey key() const#: get parameter key

inline string_t name() const#: get name

inline void name(const string_t &nm)#: set name

operator bool()#: cast Parameter to bool

operator complex_t()#: cast Parameter to complex_t

operator Complexes()#: cast Parameter to Complexes

operator const void*()#: cast Parameter to const void*

operator int()#: cast Parameter to int

operator int_t()#: cast Parameter to int_t

operator Matrix<complex_t>()#: cast Parameter to complex matrix

operator Matrix<real_t>()#: cast Parameter to real matrix

operator number_t()#: cast Parameter to number_t

operator Numbers()#: cast Parameter to Numbers

operator Point()#: cast Parameter to point

operator real_t()#: cast Parameter to real_t

operator Reals()#: cast Parameter to Reals

operator string_t()#: cast Parameter to string_t

operator Strings()#: cast Parameter to Strings

template<typename T> inline bool operator!=(const T &t)#: returns true if parameter is not t

Parameter &operator*=(const complex_t&)#: multiply by a complex_t

Parameter &operator*=(const int)#: multiply by an int

Parameter &operator*=(const int_t)#: multiply by an int_t

Parameter &operator*=(const number_t)#: multiply by a number_t

Parameter &operator*=(const Parameter&)#: multiply by a parameter

Parameter &operator*=(const real_t)#: multiply by a real_t

Parameter &operator+=(const char*)#: add a char array

Parameter &operator+=(const complex_t&)#: add a complex_t

Parameter &operator+=(const int)#: add an int

Parameter &operator+=(const int_t)#: add an int_t

Parameter &operator+=(const number_t)#: add a number_t

Parameter &operator+=(const Parameter&)#: add a parameter

Parameter &operator+=(const real_t)#: add a real_t

Parameter &operator+=(const string_t&)#: add a string_t

Parameter &operator-=(const complex_t&)#: subtract a complex_t

Parameter &operator-=(const int)#: subtract an int

Parameter &operator-=(const int_t)#: subtract an int_t

Parameter &operator-=(const number_t)#: subtract a number_t

Parameter &operator-=(const Parameter&)#: subtract a parameter

Parameter &operator-=(const real_t)#: subtract a real_t

Parameter &operator/=(const complex_t&)#: divide by a complex_t

Parameter &operator/=(const int)#: divide by an int

Parameter &operator/=(const int_t)#: divide by an int_t

Parameter &operator/=(const number_t)#: divide by a number_t

Parameter &operator/=(const Parameter&)#: divide by a parameter

Parameter &operator/=(const real_t)#: divide by a real_t

template<typename T> inline bool operator<(const T &t)#: returns true if parameter if less than t

template<typename T> inline bool operator<=(const T &t)#: returns true if parameter is less than or equal to t

inline Parameter &operator=(const BezierSpline &s)#: set to a Spline parameter

inline Parameter &operator=(const bool b)#: set to a bool

inline Parameter &operator=(const BSpline &s)#: set to a Spline parameter

inline Parameter &operator=(const C2Spline &s)#: set to a Spline parameter

inline Parameter &operator=(const CatmullRomSpline &s)#: set to a Spline parameter

inline Parameter &operator=(const char *c)#: set to a char array

inline Parameter &operator=(const CollinoIM &im)#: set to a CollinoIM parameter

inline Parameter &operator=(const complex_t &c)#: set to a complex_t

inline Parameter &operator=(const Complexes &cv)#: set to a Complexes

inline Parameter &operator=(const ComputationType ct)#: set to a ComputationType

inline Parameter &operator=(const Ctype ct)#: set to a Ctype

inline Parameter &operator=(const dimen_t i)#: set to a dimen_t

inline Parameter &operator=(const DimensionType dt)#: set to a DimensionType

inline Parameter &operator=(const DuffyIM &im)#: set to a DuffyIM parameter

inline Parameter &operator=(const EigenComputationalMode ecm)#: set to a EigenComputationalMode

inline Parameter &operator=(const EigenSolverType est)#: set to a EigenSolverType

inline Parameter &operator=(const EigenSortKind esk)#: set to a EigenSortKind

inline Parameter &operator=(const FESubType fest)#: set to a FESubType

inline Parameter &operator=(const FEType fet)#: set to a FEType

template<class T> inline Parameter &operator=(const FilonIMT<T> &im)#: set to a FilonIM parameter

inline Parameter &operator=(const FunctionPart fp)#: set to a FunctionPart

Parameter &operator=(const GeomDomain &dom)#: set to a GeomDomain

inline Parameter &operator=(const GeometricEndShape ges)#: set to a GeometricEndShape

inline Parameter &operator=(const Gtype gt)#: set to a Gtype

inline Parameter &operator=(const HMatrixIM &im)#: set to a HMatrixIM parameter

inline Parameter &operator=(const int i)#: set to an int

inline Parameter &operator=(const int_t i)#: set to an int

inline Parameter &operator=(const IntegrationMethod &im)#

Parameters:: im – set to a IntegrationMethod

inline Parameter &operator=(const IntegrationMethodType imt)#: set to a IntegrationMethodType

inline Parameter &operator=(const InterpolationType it)#: set to a InterpolationType

inline Parameter &operator=(const IOFormat iof)#: set to a IOFormat

inline Parameter &operator=(const Iptype it)#: set to a Iptype

inline Parameter &operator=(const IterativeSolverType ist)#: set to an IterativeSolverType

inline Parameter &operator=(const Language l)#: set to a Language

inline Parameter &operator=(const LenoirSalles2dIM &im)#: set to a LenoirSalles2dIM parameter

inline Parameter &operator=(const LenoirSalles2dIR &im)#: set to a LenoirSalles2dIR parameter

inline Parameter &operator=(const LenoirSalles3dIM &im)#: set to a LenoirSalles3dIM parameter

inline Parameter &operator=(const LenoirSalles3dIR &im)#: set to a LenoirSalles3dIR parameter

inline Parameter &operator=(const Matrix<complex_t> &cm)#: set to a Matrix<complex_t>

inline Parameter &operator=(const Matrix<real_t> &rm)#: set to a Matrix<real_t>

inline Parameter &operator=(const MeshGenerator mg)#: set to a MeshGenerator

inline Parameter &operator=(const number_t i)#: set to an number_t

inline Parameter &operator=(const Numbers &nv)#: set to a Numbers

inline Parameter &operator=(const Nurbs &s)#: set to a Spline parameter

inline Parameter &operator=(const Objtype ot)#: set to a Objtype

Parameter &operator=(const Parameter &p)#

default assignment operator=

assignment operator=

Parameter &operator=(const Parametrization&)#: set to a Parametrization parameter

inline Parameter &operator=(const Partitioning p)#: set to a Partitioning

inline Parameter &operator=(const Point &pt)#: set to a Point

inline Parameter &operator=(const Points &pts)#: set to a vector<Point>

inline Parameter &operator=(const PolynomialIM &im)#: set to a PolynomialIM parameter

inline Parameter &operator=(const Ptype pt)#: set to a Ptype

inline Parameter &operator=(const QuadratureIM &im)#: set to a QuadratureIM parameter

inline Parameter &operator=(const QuadRule qr)#: set to a Rtype

inline Parameter &operator=(const real_t r)#: set to a real_t

inline Parameter &operator=(const Reals &rv)#: set to a Reals

inline Parameter &operator=(const ReductionMethodType rmt)#: set to a ReductionMethodType

inline Parameter &operator=(const Rtype rt)#: set to a Rtype

inline Parameter &operator=(const SauterSchwabIM &im)#: set to a SauterSchwabIM parameter

inline Parameter &operator=(const SauterSchwabSymIM &im)#: set to a SauterSchwabSymIM parameter

inline Parameter &operator=(const ShapeType st)#: set to a ShapeType

inline Parameter &operator=(const SobolevType st)#: set to a SobolevType

inline Parameter &operator=(const Spline &s)#: set to a Spline parameter

inline Parameter &operator=(const SplineBC sbc)#: set to a SplineBC

inline Parameter &operator=(const SplineParametrization sp)#: set to a SplineParametrization

inline Parameter &operator=(const SplineSubtype sst)#: set to a SplineSubtype

inline Parameter &operator=(const SplineType st)#: set to a SplineType

inline Parameter &operator=(const std::vector<bool> &bv)#: set to a std::vector<bool>

inline Parameter &operator=(const std::vector<complex_t> &cv)#: set to a std::vector<complex_t>

inline Parameter &operator=(const std::vector<int_t> &iv)#: set to a std::vector<int_t>

inline Parameter &operator=(const std::vector<number_t> &nv)#: set to a std::vector<number_t>

inline Parameter &operator=(const std::vector<Point> &ptv)#: set to a vector<Point>

inline Parameter &operator=(const std::vector<real_t> &rv)#: set to a std::vector<real_t>

inline Parameter &operator=(const std::vector<string_t> &sv)#: set to a std::vector<string_t>

inline Parameter &operator=(const StorageAccessType sat)#: set to a StorageAccessType

inline Parameter &operator=(const StorageType st)#: set to a StorageType

inline Parameter &operator=(const string_t &s)#: set to a string_t

inline Parameter &operator=(const Strings &sv)#: set to a Strings

inline Parameter &operator=(const StructuredMeshSplitRule smsr)#: set to a StructuredMeshSplitRule

inline Parameter &operator=(const SymType st)#: set to a SymType

Parameter &operator=(const TermVectors &tvs)#: set to a IntegrationMethods

Parameter &operator=(const Transformation &t)#: set to a TermVectors

inline Parameter &operator=(const TransformType tt)#: set to a TransformType

inline Parameter &operator=(const void *p)#: set to a const void*

template<typename T_> inline Parameter &operator=(T_ t)#

set to a Transformation

set to any value

bool operator==(const bool)#: compare to a bool

bool operator==(const char*)#: compare to a string_t char

bool operator==(const complex_t&)#: compare to a complex

bool operator==(const int)#: compare to an int

bool operator==(const int_t)#: compare to an int_t

bool operator==(const number_t)#: compare to a number_t

bool operator==(const Parameter&)#: compare to a parameter

bool operator==(const real_t)#: compare to a real

bool operator==(const string_t&)#: compare to a string_t

bool operator>(const complex_t&)#: compare to a complex

bool operator>(const int)#: compare to an int

bool operator>(const int_t)#: compare to an int_t

bool operator>(const number_t)#: compare to an int_t

bool operator>(const Parameter&)#: compare to a parameter

bool operator>(const real_t)#: compare to a real

bool operator>(const string_t&)#: compare to a string_t

template<typename T> inline bool operator>=(const T &t)#: returns true if parameter is greater than or equal to t

void setToIntegrationMethod(const IntegrationMethod &im)#: set to a IntegrationMethod parameter

void setToSpline(const Spline&)#: set to a Spline parameter

inline string_t shortname(number_t i) const#: get i-eth shortname

inline Strings shortnames() const#: get shortnames

inline void shortnames(const string_t &snm)#: set shortnames

inline void shortnames(const Strings &snm)#: set shortnames

inline ValueType type() const#: get parameter type

inline string_t typeName() const#: get parameter type as string

Public Members

bool b_#: to store bool data

complex_t c_#: to store complex_t type data

int_t i_#: to store int type data

ParameterKey key_#: parameter key

string_t name_#: parameter name

const void *p_#: to store const void* data

real_t r_#: to store real_t type data

string_t s_#: to store string_t data

Strings shortnames_#: parameter shortnames

ValueType type_#: type of value

Friends

friend std::ostream &operator<<(std::ostream&, const Parameter&)#: output operator

friend std::istream &operator>>(std::istream&, Parameter&)#: insertion operator