HomotopyInput Class Reference
#include <HomotopyInput.h>
Inheritance diagram for HomotopyInput:

Public Types | |
| typedef std::vector< HomotopyVariable >::const_iterator | Iterator |
Public Member Functions | |
| HomotopyInput (void) | |
| HomotopyInput (std::string type, int id, int points) | |
| void | addControlled (const HomotopyVariable &homotopyVariable) |
| add controlled variable More... | |
| std::string | json (void) const |
| Iterator | begin (void) const |
| Iterator | end (void) const |
| bool | operator== (const HomotopyInput &rhs) const |
Protected Attributes | |
| std::string | type_ |
| int | id_ |
| int | points_ |
| std::vector< HomotopyVariable > | controlled_ |
Detailed Description
Homotopy input descriptor
#include <libpf/core/HomotopyInput.h>
Member Typedef Documentation
◆ Iterator
| typedef std::vector<HomotopyVariable>::const_iterator HomotopyInput::Iterator |
Constructor & Destructor Documentation
◆ HomotopyInput() [1/2]
| HomotopyInput::HomotopyInput | ( | void | ) |
◆ HomotopyInput() [2/2]
| HomotopyInput::HomotopyInput | ( | std::string | type, |
| int | id, | ||
| int | points | ||
| ) |
Member Function Documentation
◆ addControlled()
| void HomotopyInput::addControlled | ( | const HomotopyVariable & | homotopyVariable | ) |
add controlled variable
◆ begin()
| Iterator HomotopyInput::begin | ( | void | ) | const |
- Returns
- an Iterator to the first HomotopyVariable
◆ end()
| Iterator HomotopyInput::end | ( | void | ) | const |
- Returns
- an Iterator to the end of the HomotopyVariables
◆ json()
| std::string HomotopyInput::json | ( | void | ) | const |
- Returns
- UTF-8 encoded string with the JSON-serialized object
◆ operator==()
| bool HomotopyInput::operator== | ( | const HomotopyInput & | rhs | ) | const |
- Returns
- true if the HomotopyInput object is equal to the rhs
Member Data Documentation
◆ controlled_
|
protected |
◆ id_
|
protected |
◆ points_
|
protected |
◆ type_
|
protected |
The documentation for this class was generated from the following file: