irafhy::Variable Class Reference

#include <variable.h>

Collaboration diagram for irafhy::Variable:

Public Member Functions
	Variable ()=default
	default constructor More...
	Variable (long index)
	constructor with given variable's index More...
	~Variable ()=default
	destructor More...
std::function< capd::autodiff::Node(capd::autodiff::Node, capd::autodiff::Node[], int, capd::autodiff::Node[], int)>	arithmetic () const
	get the arithmetic function of the variable item More...
capd::interval	value (const capd::interval &t, const std::vector< capd::interval > &in, const std::vector< capd::interval > &params)
	get the value of the current variable More...

Private Attributes
long int	index_ = -2
	index of the variable in the variables' list, default set to -2(meaning invalid variable), -1 refers to the time variable More...

Friends
std::ostream &	operator<< (std::ostream &out, const Variable &rhs)
	out the given variable to the standard out stream More...

Constructor & Destructor Documentation

Variable() [1/2]

irafhy::Variable::Variable ( )

default

default constructor

Variable() [2/2]

irafhy::Variable::Variable ( long  index )

explicit

constructor with given variable's index

Parameters

index

index of the variable in the variables' list

References index_.

~Variable()

irafhy::Variable::~Variable ( )

default

destructor

Member Function Documentation

arithmetic()

std::function< capd::autodiff::Node(capd::autodiff::Node, capd::autodiff::Node[], int, capd::autodiff::Node[], int)> irafhy::Variable::arithmetic

(

)

const

get the arithmetic function of the variable item

Returns

the arithmetic function of the variable item

References index_.

value()

capd::interval irafhy::Variable::value	(	const capd::interval &	t,
		const std::vector< capd::interval > &	in,
		const std::vector< capd::interval > &	params
	)

get the value of the current variable

Parameters

t	time variable
in	values of the given variables
params	other necessary parameters

Returns

the value of the current variable

References index_.

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  out, const Variable &  rhs  )

friend

out the given variable to the standard out stream

Parameters

out	given out stream
rhs	given variable

Returns

resulting out stream

Member Data Documentation

index_

long int irafhy::Variable::index_ = -2

private

index of the variable in the variables' list, default set to -2(meaning invalid variable), -1 refers to the time variable

Referenced by arithmetic(), irafhy::operator<<(), value(), and Variable().

---

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

• /home/jianqiang/CLionProjects/irafhy/include/irafhy/representation/formal/basic/entity/variable.h
• /home/jianqiang/CLionProjects/irafhy/src/representation/formal/basic/entity/variable.cpp