Optimist Namespace Reference

Namespace for the Optimist library.

Namespaces
namespace	FiniteDifferences
namespace	Optimizer
	Namespace for multi-dimensional optimization algorithms.
namespace	RootFinder
	Namespace for multi-dimensional root-finding algorithms.
namespace	TestSet
	Namespace for the Optimist library test set functions.

Classes
struct	TypeTrait
struct	TypeTrait< ScalarType, std::enable_if_t< std::is_floating_point< ScalarType >::value > >
struct	TypeTrait< Eigen::Matrix< ScalarType, N, M >, std::enable_if_t<(N > 0 &&M > 0)> >
struct	TypeTrait< Eigen::Matrix< ScalarType, Eigen::Dynamic, 1 > >
struct	TypeTrait< Eigen::Matrix< ScalarType, Eigen::Dynamic, Eigen::Dynamic > >
struct	TypeTrait< Eigen::SparseVector< ScalarType > >
struct	TypeTrait< Eigen::SparseMatrix< ScalarType, Options, StorageIndex > >
struct	RetrieveType
struct	RetrieveType< BaseType< FirstType, Rest... > >
class	FunctionBase
	Class container for the generic function. More...
class	Function
	Class container for the vector-valued function (both input and output are vectors). More...
class	Function< T, T, DerivedFunction >
	Class container for the cost function. More...
class	SolverBase
	Class container for the generic root-finding/optimization problem solver. More...

Typedefs
using	Integer = OPTIMIST_DEFAULT_INTEGER_TYPE
	The Integer type as used for the API.

Functions
static constexpr std::string_view	table_top_left_corner ()
	Retrieve the Unicode character for the top-left corner of a table.
static constexpr std::string_view	table_top_right_corner ()
	Retrieve the Unicode character for the top-right corner of a table.
static constexpr std::string_view	table_bottom_left_corner ()
	Retrieve the Unicode character for the bottom-left corner of a table.
static constexpr std::string_view	table_bottom_right_corner ()
	Retrieve the Unicode character for the bottom-right corner of a table.
static constexpr std::string_view	table_left_junction ()
	Retrieve the Unicode character for the left junction of a table.
static constexpr std::string_view	table_right_junction ()
	Retrieve the Unicode character for the right junction of a table.
static constexpr std::string_view	table_top_junction ()
	Retrieve the Unicode character for the top junction of a table.
static constexpr std::string_view	table_bottom_junction ()
	Retrieve the Unicode character for the bottom junction of a table.
static constexpr std::string_view	table_center_cross ()
	Retrieve the Unicode character for the center cross of a table.
static constexpr std::string_view	table_horizontal_line ()
	Retrieve the Unicode character for the horizontal line of a table.
template<Integer N>
static std::string	table_horizontal_line ()
	Retrieve the Unicode character for a number of horizontal lines of a table.
static constexpr std::string_view	table_vertical_line ()
	Retrieve the Unicode character for the vertical line of a table.

Typedef Documentation

Integer

using Optimist::Integer = OPTIMIST_DEFAULT_INTEGER_TYPE

The Integer type, #define the preprocessor symbol OPTIMIST_DEFAULT_INTEGER_TYPE. The default value is int.

Function Documentation

table_bottom_junction()

constexpr std::string_view Optimist::table_bottom_junction ( )

staticconstexpr

Returns

Unicode character for the bottom junction of a table.

table_bottom_left_corner()

constexpr std::string_view Optimist::table_bottom_left_corner ( )

staticconstexpr

Returns

Unicode character for the bottom-left corner of a table.

table_bottom_right_corner()

constexpr std::string_view Optimist::table_bottom_right_corner ( )

staticconstexpr

Returns

Unicode character for the bottom-right corner of a table.

table_center_cross()

constexpr std::string_view Optimist::table_center_cross ( )

staticconstexpr

Returns

Unicode character for the center cross of a table.

table_horizontal_line() [1/2]

template<Integer N>

std::string Optimist::table_horizontal_line ( )

static

Returns

Unicode character for the horizontal lines of a table.

Template Parameters

N	Number of horizontal lines.

table_horizontal_line() [2/2]

constexpr std::string_view Optimist::table_horizontal_line ( )

staticconstexpr

Returns

Unicode character for the horizontal line of a table.

table_left_junction()

constexpr std::string_view Optimist::table_left_junction ( )

staticconstexpr

Returns

Unicode character for the left junction of a table.

table_right_junction()

constexpr std::string_view Optimist::table_right_junction ( )

staticconstexpr

Returns

Unicode character for the right junction of a table.

table_top_junction()

constexpr std::string_view Optimist::table_top_junction ( )

staticconstexpr

Returns

Unicode character for the top junction of a table.

table_top_left_corner()

constexpr std::string_view Optimist::table_top_left_corner ( )

staticconstexpr

Returns

Unicode character for the top-left corner of a table.

table_top_right_corner()

constexpr std::string_view Optimist::table_top_right_corner ( )

staticconstexpr

Returns

Unicode character for the top-right corner of a table.

table_vertical_line()

constexpr std::string_view Optimist::table_vertical_line ( )

staticconstexpr

Returns

Unicode character for the vertical line of a table.