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

An indication of what caused the execute to temrinate. More...

#include <jade.simplex.hpp>

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

Public Types
enum	type {   delta, epsilon, iteration, length,   timeout }
	The exit condition. More...

Static Public Member Functions
static const char *	str (const type value)

Detailed Description

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

An indication of what caused the execute to temrinate.

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

Member Enumeration Documentation

type

template<typename TValue >

enum jade::basic_simplex::exit_condition::type

The exit condition.

Enumerator
delta	The minimum delta occurred.
epsilon	The minimum epsilon occurred.
iteration	The maximum iteration occurred.
length	The minimum length occurred.
timeout	The maximum timeout occurred.

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

            {
                delta,     ///< The minimum delta occurred.
                epsilon,   ///< The minimum epsilon occurred.
                iteration, ///< The maximum iteration occurred.
                length,    ///< The minimum length occurred.
                timeout    ///< The maximum timeout occurred.
            };

Member Function Documentation

str()

template<typename TValue >

static const char* jade::basic_simplex< TValue >::exit_condition::str ( const type  value )

inlinestatic

Returns

A string representation of the type.

Parameters

value

The type to format.

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

            {
                switch (value)
                {
                    #define CASE(E) case E: return #E
                    CASE(delta);
                    CASE(epsilon);
                    CASE(iteration);
                    CASE(length);
                    CASE(timeout);
                    #undef CASE
                }
 
                return nullptr;
            }

---

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

• jade.simplex.hpp