HomotopyVariable Class Reference

#include <HomotopyInput.h>

Public Member Functions
	HomotopyVariable (std::string fullTag, double start, double end)
	Return the homotopy variable value for the point-th increment in the points number of increments. More...
double	value (int point, int points) const
const std::string &	fullTag (void) const
std::ostream &	print_ (std::ostream &os) const
	informative print More...
std::string	json (void) const
double	start (void) const
double	end (void) const
bool	operator== (const HomotopyVariable &rhs) const

Detailed Description

Utility struct to model an homotopy variable

#include <libpf/core/HomotopyInput.h>

Remarks

Warning

Thread safe:

Extendable:

Platform dependencies:

Constructor & Destructor Documentation

HomotopyVariable()

HomotopyVariable::HomotopyVariable	(	std::string	fullTag,
		double	start,
		double	end
	)

Return the homotopy variable value for the point-th increment in the points number of increments.

Member Function Documentation

end()

double HomotopyVariable::end

(

void

)

const

Returns

the homotopy variable ending value

fullTag()

const std::string & HomotopyVariable::fullTag

(

void

)

const

Returns

the complete path to the variable

json()

std::string HomotopyVariable::json

(

void

)

const

Returns

UTF-8 encoded string with the JSON-serialized object

operator==()

bool HomotopyVariable::operator==

(

const HomotopyVariable &

rhs

)

const

Returns

true if the HomotopyVariable object is equal to the rhs

Remarks

floating point values (start and end) are checked within a 1E-5 relative tolerance

print_()

std::ostream & HomotopyVariable::print_

(

std::ostream &

os

)

const

informative print

start()

double HomotopyVariable::start

(

void

)

const

Returns

the homotopy variable starting value

value()

double HomotopyVariable::value	(	int	point,
		int	points
	)		const

Returns

the value of the variable at point of [0 .. points]

---

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

• HomotopyInput.h