Detailed Description

Implements a polynomial of degree n.

The functor class with type "polynomial" returns

\[ f(x) = a_n x^n + \dots + a_1 x + a_0 \]

Definition at line 800 of file Func1.h.

Public Member Functions
	Poly1 (size_t n, const double *c)

	Poly1 (const vector< double > &params)
	Constructor uses \( n + 1 \) parameters in the following order: \( [a_n, \dots, a_1, a_0] \). More...

string	type () const override
	Returns a string describing the type of the function. More...

double	eval (double t) const override
	Evaluate the function. More...

Public Member Functions inherited from Func1
	Func1 (shared_ptr< Func1 > f1, shared_ptr< Func1 > f2)

	Func1 (shared_ptr< Func1 > f1, double A)

	Func1 (const Func1 &right)=delete

Func1 &	operator= (const Func1 &right)=delete

string	typeName () const
	Returns a string with the class name of the functor. More...

double	operator() (double t) const
	Calls method eval to evaluate the function. More...

virtual shared_ptr< Func1 >	derivative () const
	Creates a derivative to the current function. More...

shared_ptr< Func1 >	derivative3 () const
	Creates a derivative to the current function. More...

bool	isIdentical (Func1 &other) const
	Routine to determine if two functions are the same. More...

virtual double	isProportional (TimesConstant1 &other)

virtual double	isProportional (Func1 &other)

virtual string	write (const string &arg) const
	Write LaTeX string describing function. More...

double	c () const
	Accessor function for the stored constant. More...

shared_ptr< Func1 >	func1_shared () const
	Accessor function for m_f1_shared. More...

shared_ptr< Func1 >	func2_shared () const
	Accessor function for m_f2_shared. More...

virtual int	order () const
	Return the order of the function, if it makes sense. More...

Protected Attributes
vector< double >	m_cpoly

Protected Attributes inherited from Func1
double	m_c = 0.0

Func1 *	m_f1 = nullptr

Func1 *	m_f2 = nullptr

shared_ptr< Func1 >	m_f1_shared

shared_ptr< Func1 >	m_f2_shared

Constructor & Destructor Documentation

◆ Poly1()

Poly1 ( const vector< double > & params )

Constructor uses \( n + 1 \) parameters in the following order: \( [a_n, \dots, a_1, a_0] \).

Definition at line 215 of file Func1.cpp.

Member Function Documentation

◆ type()

string type ( ) const

inlineoverridevirtual

Returns a string describing the type of the function.

Since: New in Cantera 3.0.

Reimplemented from Func1.

Definition at line 812 of file Func1.h.

◆ eval()

double eval ( double t ) const

inlineoverridevirtual

Evaluate the function.

Reimplemented from Func1.

Definition at line 816 of file Func1.h.

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