jade::basic_simplex< TValue >::execute_args Struct Reference

Arguments to the execute method. More...

#include <jade.simplex.hpp>

Collaboration diagram for jade::basic_simplex< TValue >::execute_args:

Public Types
typedef void(*	logfunc_type) (const log_args &)
	The C-style log function. More...

Public Member Functions
	execute_args ()
	Initializes a new instance of the class. More...
bool	is_logfunc_assigned () const
bool	is_max_iterations_assigned () const
bool	is_max_seconds_assigned () const
bool	is_min_delta_assigned () const
bool	is_min_epsilon_assigned () const
bool	is_min_length_assigned () const
std::string	str () const

Data Fields
logfunc_type	logfunc
	The logging function. More...
size_t	max_iterations
	The maximum iterations. More...
double	max_seconds
	The maximum seconds. More...
value_type	min_delta
	The minimum delta. More...
value_type	min_epsilon
	The minimum change in objval. More...
value_type	min_length
	The minimum length. More...
void *	user
	User-supplied value. More...

Static Public Attributes
static constexpr auto	no_max_iterations
	The value assigned for no maximum iterations. More...
static constexpr auto	no_max_seconds
	The value assigned for no maximum seconds. More...
static constexpr auto	no_min_delta
	The value assigned for no minimum delta. More...
static constexpr auto	no_min_epsilon
	The value assigned for no minimum epsilon. More...
static constexpr auto	no_min_length
	The value assigned for no minimum length. More...

Detailed Description

template<typename TValue>
struct jade::basic_simplex< TValue >::execute_args

Arguments to the execute method.

Definition at line 156 of file jade.simplex.hpp.

Member Typedef Documentation

logfunc_type

template<typename TValue >

typedef void(* jade::basic_simplex< TValue >::execute_args::logfunc_type) (const log_args &)

The C-style log function.

Definition at line 159 of file jade.simplex.hpp.

Constructor & Destructor Documentation

execute_args()

template<typename TValue >

jade::basic_simplex< TValue >::execute_args::execute_args ( )

inline

Initializes a new instance of the class.

Definition at line 192 of file jade.simplex.hpp.

                : logfunc        (nullptr)
                , max_iterations (no_max_iterations)
                , max_seconds    (no_max_seconds)
                , min_delta      (no_min_delta)
                , min_epsilon    (no_min_epsilon)
                , min_length     (no_min_length)
                , user           (nullptr)
            {
            }

Member Function Documentation

is_logfunc_assigned()

template<typename TValue >

bool jade::basic_simplex< TValue >::execute_args::is_logfunc_assigned ( ) const

inline

Returns

True if the logging function is assigned.

Definition at line 206 of file jade.simplex.hpp.

            {
                return logfunc != nullptr;
            }

Here is the caller graph for this function:

is_max_iterations_assigned()

template<typename TValue >

bool jade::basic_simplex< TValue >::execute_args::is_max_iterations_assigned ( ) const

inline

Returns

True if the maximum iterations is assigned.

Definition at line 214 of file jade.simplex.hpp.

            {
                return max_iterations != no_max_iterations;
            }

Here is the caller graph for this function:

is_max_seconds_assigned()

template<typename TValue >

bool jade::basic_simplex< TValue >::execute_args::is_max_seconds_assigned ( ) const

inline

Returns

True if the maximum seconds is assigned.

Definition at line 222 of file jade.simplex.hpp.

            {
                return !std::isnan(max_seconds);
            }

Here is the caller graph for this function:

is_min_delta_assigned()

template<typename TValue >

bool jade::basic_simplex< TValue >::execute_args::is_min_delta_assigned ( ) const

inline

Returns

True if the minimum delta is assigned.

Definition at line 230 of file jade.simplex.hpp.

            {
                return !std::isnan(min_delta);
            }

Here is the caller graph for this function:

is_min_epsilon_assigned()

template<typename TValue >

bool jade::basic_simplex< TValue >::execute_args::is_min_epsilon_assigned ( ) const

inline

Returns

True if the minimum epsilon is assigned.

Definition at line 238 of file jade.simplex.hpp.

            {
                return !std::isnan(min_epsilon);
            }

Here is the caller graph for this function:

is_min_length_assigned()

template<typename TValue >

bool jade::basic_simplex< TValue >::execute_args::is_min_length_assigned ( ) const

inline

Returns

True if the minimum length is assigned.

Definition at line 246 of file jade.simplex.hpp.

            {
                return !std::isnan(min_length);
            }

Here is the caller graph for this function:

str()

template<typename TValue >

std::string jade::basic_simplex< TValue >::execute_args::str ( ) const

inline

Returns

A string representation of the class.

Definition at line 254 of file jade.simplex.hpp.

            {
                std::ostringstream out;
                out << "logfunc:          "
                    << _str(logfunc != nullptr, "assigned")
                    << std::endl
                    << "user:             "
                    << _str(user != nullptr, "assigned")
                    << std::endl
                    << "max_iteration:    "
                    << _str(is_max_iterations_assigned(), max_iterations)
                    << std::endl
                    << "max_second:       "
                    << _str(is_max_seconds_assigned(), max_seconds)
                    << std::endl
                    << "min_delta:        "
                    << _str(is_min_delta_assigned(), min_delta)
                    << std::endl
                    << "min_epsilon:      "
                    << _str(is_min_epsilon_assigned(), min_epsilon)
                    << std::endl
                    << "min_length:       "
                    << _str(is_min_length_assigned(), min_length)
                    << std::endl;
                return out.str();
            }

Here is the call graph for this function:

Field Documentation

logfunc

template<typename TValue >

logfunc_type jade::basic_simplex< TValue >::execute_args::logfunc

The logging function.

Definition at line 181 of file jade.simplex.hpp.

max_iterations

template<typename TValue >

size_t jade::basic_simplex< TValue >::execute_args::max_iterations

The maximum iterations.

Definition at line 182 of file jade.simplex.hpp.

max_seconds

template<typename TValue >

double jade::basic_simplex< TValue >::execute_args::max_seconds

The maximum seconds.

Definition at line 183 of file jade.simplex.hpp.

min_delta

template<typename TValue >

value_type jade::basic_simplex< TValue >::execute_args::min_delta

The minimum delta.

Definition at line 184 of file jade.simplex.hpp.

min_epsilon

template<typename TValue >

value_type jade::basic_simplex< TValue >::execute_args::min_epsilon

The minimum change in objval.

Definition at line 185 of file jade.simplex.hpp.

min_length

template<typename TValue >

value_type jade::basic_simplex< TValue >::execute_args::min_length

The minimum length.

Definition at line 186 of file jade.simplex.hpp.

no_max_iterations

template<typename TValue >

constexpr auto jade::basic_simplex< TValue >::execute_args::no_max_iterations

staticconstexpr

Initial value:

=
                std::numeric_limits<size_t>::max()

The value assigned for no maximum iterations.

Definition at line 162 of file jade.simplex.hpp.

no_max_seconds

template<typename TValue >

constexpr auto jade::basic_simplex< TValue >::execute_args::no_max_seconds

staticconstexpr

Initial value:

=
                std::numeric_limits<double>::quiet_NaN()

The value assigned for no maximum seconds.

Definition at line 166 of file jade.simplex.hpp.

no_min_delta

template<typename TValue >

constexpr auto jade::basic_simplex< TValue >::execute_args::no_min_delta

staticconstexpr

Initial value:

=
                std::numeric_limits<value_type>::quiet_NaN()

The value assigned for no minimum delta.

Definition at line 170 of file jade.simplex.hpp.

no_min_epsilon

template<typename TValue >

constexpr auto jade::basic_simplex< TValue >::execute_args::no_min_epsilon

staticconstexpr

Initial value:

=
                std::numeric_limits<value_type>::quiet_NaN()

The value assigned for no minimum epsilon.

Definition at line 174 of file jade.simplex.hpp.

no_min_length

template<typename TValue >

constexpr auto jade::basic_simplex< TValue >::execute_args::no_min_length

staticconstexpr

Initial value:

=
                std::numeric_limits<value_type>::quiet_NaN()

The value assigned for no minimum length.

Definition at line 178 of file jade.simplex.hpp.

user

template<typename TValue >

void* jade::basic_simplex< TValue >::execute_args::user

User-supplied value.

Definition at line 187 of file jade.simplex.hpp.

---

The documentation for this struct was generated from the following file:

• jade.simplex.hpp