Templated storage for the roots of polynomial equations, plus flags to indicate the nature of the roots. More...

#include <Roots.H>

Inheritance diagram for Roots< N >:

Collaboration diagram for Roots< N >:

Public Member Functions
	Roots ()
	Default construct as 'nan'.
	Roots (const roots::type t, const scalar x)
	Construct with a uniform value.
	Roots (const roots::type t, const scalar x, const Roots< N - 1 > &xs)
	Construct by concatenation.
	Roots (const Roots< N - 1 > &xs, const roots::type t, const scalar x)
	Construct by concatenation.
template<direction M>
	Roots (const Roots< M > &xs, const Roots< N - M > &ys)
	Construct by concatenation.
void	type (const direction i, const roots::type t)
	Set the type of the i-th root.
roots::type	type (const direction i) const
	Return the type of the i-th root.
Public Member Functions inherited from VectorSpace< Roots< N >, scalar, N >
const Foam::VectorSpace< Roots< N >, scalar, Ncmpts >::template ConstBlock< SubVector, BStart >	block () const
	VectorSpace ()=default
	Default construct.
const scalar &	component (const direction) const
void	replace (const direction, const scalar &)
const scalar *	cdata () const noexcept
	Return const pointer to the first data element.
scalar *	data () noexcept
	Return pointer to the first data element.
void	fill (const scalar &s)
	Assign all components to given value.
const scalar &	operator[] (const direction) const
void	operator= (const VectorSpace< Roots< N >, scalar, Ncmpts > &)
void	operator+= (const VectorSpace< Roots< N >, scalar, Ncmpts > &)
void	operator-= (const VectorSpace< Roots< N >, scalar, Ncmpts > &)
void	operator*= (const scalar)
void	operator/= (const scalar)
iterator	begin () noexcept
	Return an iterator (pointer) to begin of VectorSpace.
const_iterator	cbegin () const noexcept
	Return const_iterator (const pointer) to begin of VectorSpace.
iterator	end () noexcept
	Return an iterator (pointer) to end of VectorSpace.
const_iterator	cend () const noexcept
	Return const_iterator (const pointer) to end of VectorSpace.

Additional Inherited Members
Public Types inherited from VectorSpace< Roots< N >, scalar, N >
typedef VectorSpace< Roots< N >, scalar, Ncmpts >	vsType
	VectorSpace type.
typedef scalar	cmptType
	Component type.
typedef scalar	magType
	Magnitude type.
typedef direction	size_type
	The type to represent the size of a VectorSpace.
typedef scalar *	iterator
	Random access iterator for traversing VectorSpace.
typedef const scalar *	const_iterator
	Random access iterator for traversing VectorSpace.
Static Public Member Functions inherited from VectorSpace< Roots< N >, scalar, N >
static constexpr direction	size () noexcept
	The number of elements in the VectorSpace = Ncmpts.
static Roots< N >	uniform (const scalar &s)
	Return a VectorSpace with all elements = s.
Public Attributes inherited from VectorSpace< Roots< N >, scalar, N >
scalar	v_ [Ncmpts]
	The components of this vector space.
Static Public Attributes inherited from VectorSpace< Roots< N >, scalar, N >
static constexpr direction	dim
	Dimensionality of space.
static constexpr direction	nComponents
	Number of components in this vector space.
static constexpr direction	mRows
static constexpr direction	nCols
static const char *const	typeName
static const char *const	componentNames []
static const Roots< N >	zero
static const Roots< N >	one
static const Roots< N >	max
static const Roots< N >	min
static const Roots< N >	rootMax
static const Roots< N >	rootMin