Optimist  0.0.0
A C++ library for optimization
Loading...
Searching...
No Matches
Optimist Namespace Reference

Namespace for the Optimist library.

Namespaces

namespace  FiniteDifference
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

class  Function
 Class container for the vector-valued function. More...
class  Function< Real, 1, 1, DerivedFunction >
 Class container for the scalar function. More...
class  Function< Real, N, 1, DerivedFunction >
 Class container for the cost function. More...
class  FunctionBase
 Class container for the generic 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 std::string table_top_left_corner ()
 Retrieve the Unicode character for the top-left corner of a table.
static std::string table_top_right_corner ()
 Retrieve the Unicode character for the top-right corner of a table.
static std::string table_bottom_left_corner ()
 Retrieve the Unicode character for the bottom-left corner of a table.
static std::string table_bottom_right_corner ()
 Retrieve the Unicode character for the bottom-right corner of a table.
static std::string table_left_junction ()
 Retrieve the Unicode character for the left junction of a table.
static std::string table_right_junction ()
 Retrieve the Unicode character for the right junction of a table.
static std::string table_top_junction ()
 Retrieve the Unicode character for the top junction of a table.
static std::string table_bottom_junction ()
 Retrieve the Unicode character for the bottom junction of a table.
static std::string table_center_cross ()
 Retrieve the Unicode character for the center cross of a table.
static std::string 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 std::string table_vertical_line ()
 Retrieve the Unicode character for the vertical line of a table.

Typedef Documentation

◆ Integer

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

Function Documentation

◆ table_bottom_junction()

std::string Optimist::table_bottom_junction ( )
inlinestatic
Returns
Unicode character for the bottom junction of a table.

◆ table_bottom_left_corner()

std::string Optimist::table_bottom_left_corner ( )
inlinestatic
Returns
Unicode character for the bottom-left corner of a table.

◆ table_bottom_right_corner()

std::string Optimist::table_bottom_right_corner ( )
inlinestatic
Returns
Unicode character for the bottom-right corner of a table.

◆ table_center_cross()

std::string Optimist::table_center_cross ( )
inlinestatic
Returns
Unicode character for the center cross of a table.

◆ table_horizontal_line() [1/2]

std::string Optimist::table_horizontal_line ( )
inlinestatic
Returns
Unicode character for the horizontal line of a table.

◆ table_horizontal_line() [2/2]

template<Integer N>
std::string Optimist::table_horizontal_line ( )
inlinestatic
Returns
Unicode character for the horizontal lines of a table.
Template Parameters
NNumber of horizontal lines.

◆ table_left_junction()

std::string Optimist::table_left_junction ( )
inlinestatic
Returns
Unicode character for the left junction of a table.

◆ table_right_junction()

std::string Optimist::table_right_junction ( )
inlinestatic
Returns
Unicode character for the right junction of a table.

◆ table_top_junction()

std::string Optimist::table_top_junction ( )
inlinestatic
Returns
Unicode character for the top junction of a table.

◆ table_top_left_corner()

std::string Optimist::table_top_left_corner ( )
inlinestatic
Returns
Unicode character for the top-left corner of a table.

◆ table_top_right_corner()

std::string Optimist::table_top_right_corner ( )
inlinestatic
Returns
Unicode character for the top-right corner of a table.

◆ table_vertical_line()

std::string Optimist::table_vertical_line ( )
inlinestatic
Returns
Unicode character for the vertical line of a table.