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

Arguments passed to the logging function. More...

#include <jade.simplex.hpp>

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

Public Member Functions
	log_args (const basic_simplex *const simplex_, const double second_, const size_t iteration_, void *const user_)
	Initializes a new instance of the class. More...
std::string	str () const

Data Fields
size_t	iteration
	The completed iteration. More...
double	second
	The seconds elapsed. More...
const basic_simplex *	simplex
	The simplex instance. More...
void *	user
	User-supplied value. More...

Detailed Description

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

Arguments passed to the logging function.

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

Constructor & Destructor Documentation

log_args()

template<typename TValue >

jade::basic_simplex< TValue >::log_args::log_args ( const basic_simplex *const  simplex_, const double  second_, const size_t  iteration_, void *const  user_  )

inline

Initializes a new instance of the class.

Parameters

simplex_	The simplex generating the log event.
second_	The number of seconds elapsed.
iteration_	The completed iteration.
user_	The user-supplied value, or nullptr.

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

                : iteration (iteration_)
                , second    (second_)
                , simplex   (simplex_)
                , user      (user_)
            {
            }

Member Function Documentation

str()

template<typename TValue >

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

inline

Returns

A string representation of the class.

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

            {
                std::ostringstream out;
                out << "iteration:        " << iteration << std::endl
                    << "second:           " << second    << std::endl;
                return out.str();
            }

Field Documentation

iteration

template<typename TValue >

size_t jade::basic_simplex< TValue >::log_args::iteration

The completed iteration.

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

second

template<typename TValue >

double jade::basic_simplex< TValue >::log_args::second

The seconds elapsed.

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

simplex

template<typename TValue >

const basic_simplex* jade::basic_simplex< TValue >::log_args::simplex

The simplex instance.

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

user

template<typename TValue >

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

User-supplied value.

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

---

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

• jade.simplex.hpp