coco::ie_return_type Class Reference
[Module Base Classes]
The return class of all inference engines.
More...
#include <ie_rettype.h>
Public Member Functions | |
| ie_return_type () | |
| ie_return_type (const termination_reason &__t) | |
| ie_return_type (const delta_base *__d, double __w) | |
| ie_return_type (const delta_base *__d, double __w, const certificate_base *__c) | |
| ie_return_type (const std::pair< delta_base *, double > &__d) | |
| ie_return_type (const std::triple< delta_base *, double, certificate_base * > &__d) | |
| ie_return_type (delta __d, double __w) | |
| ie_return_type (delta __d, double __w, certificate __c) | |
| ie_return_type (const std::pair< delta, double > &__d) | |
| ie_return_type (const std::triple< delta, double, certificate > &__d) | |
| ie_return_type (const std::list< delta > &__d, const std::list< double > &__w) | |
| ie_return_type (const std::list< delta > &__d, const std::list< double > &__w, const std::list< certificate > &__c) | |
| ie_return_type (const delta_base *__d, double __w, const termination_reason &__t) | |
| ie_return_type (const delta_base *__d, double __w, const certificate_base *__c, const termination_reason &__t) | |
| ie_return_type (const std::pair< delta_base *, double > &__d, const termination_reason &__t) | |
| ie_return_type (const std::triple< delta_base *, double, certificate_base * > &__d, const termination_reason &__t) | |
| ie_return_type (delta __d, double __w, const termination_reason &__t) | |
| ie_return_type (delta __d, double __w, certificate __c, const termination_reason &__t) | |
| ie_return_type (const std::pair< delta, double > &__d, const termination_reason &__t) | |
| ie_return_type (const std::triple< delta, double, certificate > &__d, const termination_reason &__t) | |
| ie_return_type (const std::list< delta > &__d, const std::list< double > &__w, const termination_reason &__t) | |
| ie_return_type (const std::list< delta > &__d, const std::list< double > &__w, const std::list< certificate > &__c, const termination_reason &__t) | |
| ie_return_type (const ie_return_type &__r) | |
| virtual | ~ie_return_type () |
| void | set_termination_reason (const termination_reason &__t) |
| const termination_reason & | term_reason () const |
| ie_return_type | operator+ (const std::pair< delta_base *, double > &__d) |
| ie_return_type & | operator+= (const std::pair< delta_base *, double > &__d) |
| ie_return_type | operator+ (const std::triple< delta_base *, double, certificate_base * > &__d) |
| ie_return_type & | operator+= (const std::triple< delta_base *, double, certificate_base * > &__d) |
| ie_return_type & | operator= (const ie_return_type &__d) |
| unsigned int | n_deltas () const |
| const std::list< delta_id > & | get (work_node &wn, double thresh=-COCO_INF) |
| void | getd (std::list< delta > &dels, std::list< certificate > &certl, double thresh) |
| const info_contents & | get_info () const |
| bool | set_information (const std::string &iname, const basic_alltype &a, bool force=false) |
| bool | set_information (const char *iname, const basic_alltype &a, bool force=false) |
| bool | set_information_i (const std::string &iname, int i, const basic_alltype &a, bool force=false) |
| bool | set_information_i (const char *iname, int i, const basic_alltype &a, bool force=false) |
| const basic_alltype & | information (const std::string &iname) const |
| const basic_alltype & | information (const char *iname) const |
| const basic_alltype & | information (const std::string &iname, int i) const |
| const basic_alltype & | information (const char *iname, int i) const |
| bool | has_information (const std::string &__s) const |
| bool | has_information (const char *__s) const |
| bool | has_information (const std::string &__s, int i) const |
| bool | has_information (const char *__s, int i) const |
| bool | information_indices_set (const std::string &__s, std::vector< int > &__idx) const |
| bool | information_indices_set (const char *__s, std::vector< int > &__idx) const |
| void | unset_information (const std::string &__s) |
| void | unset_information (const char *__s) |
| void | unset_information (const std::string &__s, int i) |
| void | unset_information (const char *__s, int i) |
| template<class _TS > | |
| bool | retrieve_from_info (const std::string &__s, const std::vector< _TS > *&__b) const |
| template<class _TS > | |
| bool | retrieve_from_info (const std::string &__s, const linalg::matrix< _TS > *&__b) const |
| template<class _TS > | |
| bool | retrieve_from_info (const std::string &__s, _TS &__b) const |
| template<class _TS > | |
| bool | retrieve_from_info (const char *__s, const std::vector< _TS > *&__b) const |
| template<class _TS > | |
| bool | retrieve_from_info (const char *__s, const linalg::matrix< _TS > *&__b) const |
| template<class _TS > | |
| bool | retrieve_from_info (const char *__s, _TS &__b) const |
| template<class _TS > | |
| bool | retrieve_from_info (const std::string &__s, const std::vector< _TS > *&__b, const std::vector< _TS > *__def) const |
| template<class _TS > | |
| bool | retrieve_from_info (const std::string &__s, const linalg::matrix< _TS > *&__b, const linalg::matrix< _TS > *__def) const |
| template<class _TS > | |
| bool | retrieve_from_info (const std::string &__s, _TS &__b, const _TS &__def) const |
| template<class _TS > | |
| bool | retrieve_from_info (const char *__s, const std::vector< _TS > *&__b, const std::vector< _TS > *__def) const |
| template<class _TS > | |
| bool | retrieve_from_info (const char *__s, const linalg::matrix< _TS > *&__b, const linalg::matrix< _TS > *__def) const |
| template<class _TS > | |
| bool | retrieve_from_info (const char *__s, _TS &__b, const _TS &__def) const |
| template<class _TS > | |
| bool | retrieve_from_info_i (const std::string &__s, int i, const std::vector< _TS > *&__b) const |
| template<class _TS > | |
| bool | retrieve_from_info_i (const std::string &__s, int i, const linalg::matrix< _TS > *&__b) const |
| template<class _TS > | |
| bool | retrieve_from_info_i (const std::string &__s, int i, _TS &__b) const |
| template<class _TS > | |
| bool | retrieve_from_info_i (const char *__s, int i, const std::vector< _TS > *&__b) const |
| template<class _TS > | |
| bool | retrieve_from_info_i (const char *__s, int i, const linalg::matrix< _TS > *&__b) const |
| template<class _TS > | |
| bool | retrieve_from_info_i (const char *__s, int i, _TS &__b) const |
| template<class _TS > | |
| bool | retrieve_from_info_i (const std::string &__s, int i, const std::vector< _TS > *&__b, const std::vector< _TS > *__def) const |
| template<class _TS > | |
| bool | retrieve_from_info_i (const std::string &__s, int i, const linalg::matrix< _TS > *&__b, const linalg::matrix< _TS > *__def) const |
| template<class _TS > | |
| bool | retrieve_from_info_i (const std::string &__s, int i, _TS &__b, const _TS &__def) const |
| template<class _TS > | |
| bool | retrieve_from_info_i (const char *__s, int i, const std::vector< _TS > *&__b, const std::vector< _TS > *__def) const |
| template<class _TS > | |
| bool | retrieve_from_info_i (const char *__s, int i, const linalg::matrix< _TS > *&__b, const linalg::matrix< _TS > *__def) const |
| template<class _TS > | |
| bool | retrieve_from_info_i (const char *__s, int i, _TS &__b, const _TS &__def) const |
Detailed Description
This class is returned by theinfer method of all COCONUT inference engines. It holds the reason of termination (the return code) of the engine, the deltas with weights and certificates calculated by the engine, and additional information the engine provides.
Definition at line 49 of file ie_rettype.h.
Constructor & Destructor Documentation
| coco::ie_return_type::ie_return_type | ( | ) | [inline] |
Standard Constructor
Definition at line 71 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const termination_reason & | __t | ) | [inline] |
Constructor, which sets the termination_reason to __t
Definition at line 73 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const delta_base * | __d, | |
| double | __w | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with one delta __d and the corresponding weight __w.
Definition at line 77 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const delta_base * | __d, | |
| double | __w, | |||
| const certificate_base * | __c | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with one delta __d, the corresponding weight __w and certificate __c.
Definition at line 83 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const std::pair< delta_base *, double > & | __d | ) | [inline] |
Constructor, which initializes the ie_return_type with one delta and the corresponding weight collected in a pair __d.
Definition at line 90 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const std::triple< delta_base *, double, certificate_base * > & | __d | ) | [inline] |
Constructor, which initializes the ie_return_type with one delta, the corresponding weight and certificate collected in a triple __d.
Definition at line 96 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | delta | __d, | |
| double | __w | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with one delta __d and the corresponding weight __w.
Definition at line 103 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | delta | __d, | |
| double | __w, | |||
| certificate | __c | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with one delta __d, the corresponding weight __w and certificate __c.
Definition at line 109 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const std::pair< delta, double > & | __d | ) | [inline] |
Constructor, which initializes the ie_return_type with one delta and the corresponding weight collected in a pair __d.
Definition at line 114 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const std::triple< delta, double, certificate > & | __d | ) | [inline] |
Constructor, which initializes the ie_return_type with one delta, the corresponding weight and certificate collected in a triple __d.
Definition at line 119 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const std::list< delta > & | __d, | |
| const std::list< double > & | __w | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with a list of deltas and the corresponding list of weights.
Definition at line 124 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const std::list< delta > & | __d, | |
| const std::list< double > & | __w, | |||
| const std::list< certificate > & | __c | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with a list of deltas and the corresponding lists of weights and certificates.
Definition at line 136 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const delta_base * | __d, | |
| double | __w, | |||
| const termination_reason & | __t | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with one delta __d, the corresponding weight __w, and the reason of termination __t.
Definition at line 147 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const delta_base * | __d, | |
| double | __w, | |||
| const certificate_base * | __c, | |||
| const termination_reason & | __t | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with one delta __d, the corresponding weight __w and certificate __c, and the reason of termination __t.
Definition at line 155 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const std::pair< delta_base *, double > & | __d, | |
| const termination_reason & | __t | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with one delta and the corresponding weight collected in a pair __d, and the reason of termination __t.
Definition at line 163 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const std::triple< delta_base *, double, certificate_base * > & | __d, | |
| const termination_reason & | __t | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with one delta, the corresponding weight and certificate collected in a triple __d, and the reason of termination __t.
Definition at line 171 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | delta | __d, | |
| double | __w, | |||
| const termination_reason & | __t | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with one delta __d, the corresponding weight __w, and the reason of termination __t.
Definition at line 179 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | delta | __d, | |
| double | __w, | |||
| certificate | __c, | |||
| const termination_reason & | __t | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with one delta __d, the corresponding weight __w and certificate __c, and the reason of termination __t.
Definition at line 186 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const std::pair< delta, double > & | __d, | |
| const termination_reason & | __t | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with one delta and the corresponding weight collected in a pair __d, and the reason of termination __t.
Definition at line 194 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const std::triple< delta, double, certificate > & | __d, | |
| const termination_reason & | __t | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with one delta, the corresponding weight and certificate collected in a triple __d, and the reason of termination __t.
Definition at line 201 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const std::list< delta > & | __d, | |
| const std::list< double > & | __w, | |||
| const termination_reason & | __t | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with a list of deltas and the corresponding list of weights, and the reason of termination __t.
Definition at line 208 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const std::list< delta > & | __d, | |
| const std::list< double > & | __w, | |||
| const std::list< certificate > & | __c, | |||
| const termination_reason & | __t | |||
| ) | [inline] |
Constructor, which initializes the ie_return_type with a list of deltas and the corresponding lists of weights and certificates, and the reason of termination __t.
Definition at line 222 of file ie_rettype.h.
| coco::ie_return_type::ie_return_type | ( | const ie_return_type & | __r | ) | [inline] |
Standard Copy Constructor
Definition at line 233 of file ie_rettype.h.
| virtual coco::ie_return_type::~ie_return_type | ( | ) | [inline, virtual] |
Standard Destructor
Definition at line 238 of file ie_rettype.h.
Member Function Documentation
| const std::list< delta_id > & coco::ie_return_type::get | ( | work_node & | wn, | |
| double | thresh = -COCO_INF | |||
| ) |
This method gets all deltas with weight greater or equal thresh. A delta can be got at most once from any of and . The method converts and stores the delta in the deltas table of the search database. A second call to get or getd returns only deltas which have not previously been got. The work_node wn becomes the keeper work node of the retrieved deltas.
Definition at line 34 of file ie_rettype.cc.
| const info_contents & coco::ie_return_type::get_info | ( | ) | const [inline] |
This method accesses the whole info content.
Definition at line 33 of file ie_rettype.hpp.
| void coco::ie_return_type::getd | ( | std::list< delta > & | dels, | |
| std::list< certificate > & | certl, | |||
| double | thresh | |||
| ) |
This method gets all deltas with weight greater or equal thresh. A delta can be got at most once from any of and . A second call to either of get and returns only deltas which have not previously been got. The deltas and corresponding certificates are appended to the lists dels and certs, respectively.
Definition at line 74 of file ie_rettype.cc.
| bool coco::ie_return_type::has_information | ( | const char * | __s, | |
| int | i | |||
| ) | const [inline] |
This method checks whether the variable iname with index i is defined in the information structure.
Definition at line 181 of file ie_rettype.hpp.
| bool coco::ie_return_type::has_information | ( | const std::string & | __s, | |
| int | i | |||
| ) | const [inline] |
This method checks whether the variable iname with index i is defined in the information structure.
Definition at line 176 of file ie_rettype.hpp.
| bool coco::ie_return_type::has_information | ( | const char * | __s | ) | const [inline] |
This method checks whether the variable iname is defined in the information structure.
Definition at line 171 of file ie_rettype.hpp.
| bool coco::ie_return_type::has_information | ( | const std::string & | __s | ) | const [inline] |
This method checks whether the variable iname is defined in the information structure.
Definition at line 166 of file ie_rettype.hpp.
| const basic_alltype & coco::ie_return_type::information | ( | const char * | iname, | |
| int | i | |||
| ) | const [inline] |
This method retrieves the value of the variable iname with index i from the information structure.
Definition at line 160 of file ie_rettype.hpp.
| const basic_alltype & coco::ie_return_type::information | ( | const std::string & | iname, | |
| int | i | |||
| ) | const [inline] |
This method retrieves the value of the variable iname with index i from the information structure.
Definition at line 154 of file ie_rettype.hpp.
| const basic_alltype & coco::ie_return_type::information | ( | const char * | iname | ) | const [inline] |
This method retrieves the value of the variable iname from the information structure.
Definition at line 148 of file ie_rettype.hpp.
| const basic_alltype & coco::ie_return_type::information | ( | const std::string & | iname | ) | const [inline] |
This method retrieves the value of the variable iname from the information structure.
Definition at line 142 of file ie_rettype.hpp.
| bool coco::ie_return_type::information_indices_set | ( | const char * | __s, | |
| std::vector< int > & | __idx | |||
| ) | const [inline] |
The information_indices_set methods set __idx to the list of indices defined for the variable with name __s. The methods return whether the variable __s is defined.
Definition at line 192 of file ie_rettype.hpp.
| bool coco::ie_return_type::information_indices_set | ( | const std::string & | __s, | |
| std::vector< int > & | __idx | |||
| ) | const [inline] |
The information_indices_set methods set __idx to the list of indices defined for the variable with name __s. The methods return whether the variable __s is defined.
Definition at line 186 of file ie_rettype.hpp.
| unsigned int coco::ie_return_type::n_deltas | ( | ) | const [inline] |
This method returns the number of deltas defined.
Definition at line 469 of file ie_rettype.h.
| ie_return_type coco::ie_return_type::operator+ | ( | const std::triple< delta_base *, double, certificate_base * > & | __d | ) | [inline] |
This operator adds another delta with weight and certificate to the ie_return_type.
Definition at line 69 of file ie_rettype.hpp.
| ie_return_type coco::ie_return_type::operator+ | ( | const std::pair< delta_base *, double > & | __d | ) | [inline] |
This operator adds another delta with weight to the ie_return_type.
Definition at line 48 of file ie_rettype.hpp.
| ie_return_type & coco::ie_return_type::operator+= | ( | const std::triple< delta_base *, double, certificate_base * > & | __d | ) | [inline] |
This operator increments the ie_return_type with another delta with weight and certificate.
Definition at line 79 of file ie_rettype.hpp.
| ie_return_type & coco::ie_return_type::operator+= | ( | const std::pair< delta_base *, double > & | __d | ) | [inline] |
This operator increments the ie_return_type with another delta with weight.
Definition at line 58 of file ie_rettype.hpp.
| ie_return_type & coco::ie_return_type::operator= | ( | const ie_return_type & | __d | ) | [inline] |
Standard Assignment Operator
Definition at line 105 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info | ( | const char * | __s, | |
| _TS & | __b, | |||
| const _TS & | __def | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s of the information structure in __b. If the variable is undefined the method assigns the default value __def to __b. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations. The method returns true if any assignment to __b was successful.
Definition at line 295 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info | ( | const char * | __s, | |
| const linalg::matrix< _TS > *& | __b, | |||
| const linalg::matrix< _TS > * | __def | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s of the information structure in __b. If the variable is undefined the method assigns the default value __def to __b. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations. The method returns true if any assignment to __b was successful.
Definition at line 288 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info | ( | const char * | __s, | |
| const std::vector< _TS > *& | __b, | |||
| const std::vector< _TS > * | __def | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s of the information structure in __b. If the variable is undefined the method assigns the default value __def to __b. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations. The method returns true if any assignment to __b was successful.
Definition at line 281 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info | ( | const std::string & | __s, | |
| _TS & | __b, | |||
| const _TS & | __def | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s of the information structure in __b. If the variable is undefined the method assigns the default value __def to __b. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations. The method returns true if any assignment to __b was successful.
Definition at line 254 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info | ( | const std::string & | __s, | |
| const linalg::matrix< _TS > *& | __b, | |||
| const linalg::matrix< _TS > * | __def | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s of the information structure in __b. If the variable is undefined the method assigns the default value __def to __b. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations. The method returns true if any assignment to __b was successful.
Definition at line 247 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info | ( | const std::string & | __s, | |
| const std::vector< _TS > *& | __b, | |||
| const std::vector< _TS > * | __def | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s of the information structure in __b. If the variable is undefined the method assigns the default value __def to __b. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations. The method returns true if any assignment to __b was successful.
Definition at line 240 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info | ( | const char * | __s, | |
| _TS & | __b | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s of the information structure in __b. If the variable is undefined the method returns false. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations.
Definition at line 275 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info | ( | const char * | __s, | |
| const linalg::matrix< _TS > *& | __b | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s of the information structure in __b. If the variable is undefined the method returns false. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations.
Definition at line 268 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info | ( | const char * | __s, | |
| const std::vector< _TS > *& | __b | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s of the information structure in __b. If the variable is undefined the method returns false. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations.
Definition at line 261 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info | ( | const std::string & | __s, | |
| _TS & | __b | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s of the information structure in __b. If the variable is undefined the method returns false. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations.
Definition at line 233 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info | ( | const std::string & | __s, | |
| const linalg::matrix< _TS > *& | __b | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s of the information structure in __b. If the variable is undefined the method returns false. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations.
Definition at line 226 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info | ( | const std::string & | __s, | |
| const std::vector< _TS > *& | __b | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s of the information structure in __b. If the variable is undefined the method returns false. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations.
Definition at line 219 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info_i | ( | const char * | __s, | |
| int | i, | |||
| _TS & | __b, | |||
| const _TS & | __def | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s with index i of the information structure in __b. If the variable is undefined the method assigns the default value __def to __b. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations. The method returns true if any assignment to __b was successful.
Definition at line 379 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info_i | ( | const char * | __s, | |
| int | i, | |||
| const linalg::matrix< _TS > *& | __b, | |||
| const linalg::matrix< _TS > * | __def | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s with index i of the information structure in __b. If the variable is undefined the method assigns the default value __def to __b. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations. The method returns true if any assignment to __b was successful.
Definition at line 372 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info_i | ( | const char * | __s, | |
| int | i, | |||
| const std::vector< _TS > *& | __b, | |||
| const std::vector< _TS > * | __def | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s with index i of the information structure in __b. If the variable is undefined the method assigns the default value __def to __b. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations. The method returns true if any assignment to __b was successful.
Definition at line 365 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info_i | ( | const std::string & | __s, | |
| int | i, | |||
| _TS & | __b, | |||
| const _TS & | __def | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s with index i of the information structure in __b. If the variable is undefined the method assigns the default value __def to __b. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations. The method returns true if any assignment to __b was successful.
Definition at line 337 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info_i | ( | const std::string & | __s, | |
| int | i, | |||
| const linalg::matrix< _TS > *& | __b, | |||
| const linalg::matrix< _TS > * | __def | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s with index i of the information structure in __b. If the variable is undefined the method assigns the default value __def to __b. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations. The method returns true if any assignment to __b was successful.
Definition at line 330 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info_i | ( | const std::string & | __s, | |
| int | i, | |||
| const std::vector< _TS > *& | __b, | |||
| const std::vector< _TS > * | __def | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s with index i of the information structure in __b. If the variable is undefined the method assigns the default value __def to __b. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations. The method returns true if any assignment to __b was successful.
Definition at line 323 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info_i | ( | const char * | __s, | |
| int | i, | |||
| _TS & | __b | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s with index i of the information structure in __b. If the variable is undefined the method returns false. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations.
Definition at line 358 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info_i | ( | const char * | __s, | |
| int | i, | |||
| const linalg::matrix< _TS > *& | __b | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s with index i of the information structure in __b. If the variable is undefined the method returns false. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations.
Definition at line 351 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info_i | ( | const char * | __s, | |
| int | i, | |||
| const std::vector< _TS > *& | __b | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s with index i of the information structure in __b. If the variable is undefined the method returns false. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations.
Definition at line 344 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info_i | ( | const std::string & | __s, | |
| int | i, | |||
| _TS & | __b | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s with index i of the information structure in __b. If the variable is undefined the method returns false. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations.
Definition at line 316 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info_i | ( | const std::string & | __s, | |
| int | i, | |||
| const linalg::matrix< _TS > *& | __b | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s with index i of the information structure in __b. If the variable is undefined the method returns false. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations.
Definition at line 309 of file ie_rettype.hpp.
| bool coco::ie_return_type::retrieve_from_info_i | ( | const std::string & | __s, | |
| int | i, | |||
| const std::vector< _TS > *& | __b | |||
| ) | const [inline] |
The retrieve_from_info method stores the contents of variable __s with index i of the information structure in __b. If the variable is undefined the method returns false. Note that the simple types are assigned but for the complex types only pointers are set to the contents of the information structure, in order to reduce unnecessary big copy operations.
Definition at line 302 of file ie_rettype.hpp.
| bool coco::ie_return_type::set_information | ( | const char * | iname, | |
| const basic_alltype & | a, | |||
| bool | force = false | |||
| ) | [inline] |
This method sets the variable iname in the information structure to a. If force is true the variable will be overwritten if it is already set. The method returns whether the set operation was successful.
Definition at line 124 of file ie_rettype.hpp.
| bool coco::ie_return_type::set_information | ( | const std::string & | iname, | |
| const basic_alltype & | a, | |||
| bool | force = false | |||
| ) | [inline] |
This method sets the variable iname in the information structure to a. If force is true the variable will be overwritten if it is already set. The method returns whether the set operation was successful.
Definition at line 118 of file ie_rettype.hpp.
| bool coco::ie_return_type::set_information_i | ( | const char * | iname, | |
| int | i, | |||
| const basic_alltype & | a, | |||
| bool | force = false | |||
| ) | [inline] |
This method sets the variable iname with index i in the information structure to a. If force is true the variable will be overwritten if it is already set. The method returns whether the set operation was successful.
Definition at line 136 of file ie_rettype.hpp.
| bool coco::ie_return_type::set_information_i | ( | const std::string & | iname, | |
| int | i, | |||
| const basic_alltype & | a, | |||
| bool | force = false | |||
| ) | [inline] |
This method sets the variable iname with index i in the information structure to a. If force is true the variable will be overwritten if it is already set. The method returns whether the set operation was successful.
Definition at line 130 of file ie_rettype.hpp.
| void coco::ie_return_type::set_termination_reason | ( | const termination_reason & | __t | ) | [inline] |
This method sets the termination_reason to __t.
Definition at line 38 of file ie_rettype.hpp.
| const termination_reason & coco::ie_return_type::term_reason | ( | ) | const [inline] |
This method returns the reason of termination.
Definition at line 43 of file ie_rettype.hpp.
| void coco::ie_return_type::unset_information | ( | const char * | __s, | |
| int | i | |||
| ) | [inline] |
This method removes the variable __s with index i from the information structure.
Definition at line 213 of file ie_rettype.hpp.
| void coco::ie_return_type::unset_information | ( | const std::string & | __s, | |
| int | i | |||
| ) | [inline] |
This method removes the variable __s with index i from the information structure.
Definition at line 208 of file ie_rettype.hpp.
| void coco::ie_return_type::unset_information | ( | const char * | __s | ) | [inline] |
This method removes the variable __s from the information structure.
Definition at line 203 of file ie_rettype.hpp.
| void coco::ie_return_type::unset_information | ( | const std::string & | __s | ) | [inline] |
This method removes the variable __s from the information structure.
Definition at line 198 of file ie_rettype.hpp.
The documentation for this class was generated from the following files:
