ʻOhana
Population structure, admixture history, and selection using learning methods.
Public Types | Static Public Member Functions
jade::basic_lemke< TValue >::state Struct Reference

Possible states of the algorithm. More...

#include <jade.lemke.hpp>

+ Collaboration diagram for jade::basic_lemke< TValue >::state:

Public Types

enum  type {
  executing, completed, aborted_initialization, aborted_elimination,
  aborted_pivot
}
 The state type. More...
 

Static Public Member Functions

static const char * str (const type value)
 

Detailed Description

template<typename TValue>
struct jade::basic_lemke< TValue >::state

Possible states of the algorithm.

Definition at line 30 of file jade.lemke.hpp.

Member Enumeration Documentation

◆ type

template<typename TValue >
enum jade::basic_lemke::state::type

The state type.

Enumerator
executing 

The algorithm is executing.

completed 

The algorithm completed.

aborted_initialization 

Aborted during initialization.

aborted_elimination 

Aborted with an invalid pivot.

aborted_pivot 

Aborted finding the pivot.

Definition at line 35 of file jade.lemke.hpp.

36  {
37  executing, ///< The algorithm is executing.
38  completed, ///< The algorithm completed.
39  aborted_initialization, ///< Aborted during initialization.
40  aborted_elimination, ///< Aborted with an invalid pivot.
41  aborted_pivot ///< Aborted finding the pivot.
42  };

Member Function Documentation

◆ str()

template<typename TValue >
static const char* jade::basic_lemke< TValue >::state::str ( const type  value)
inlinestatic
Returns
The string representation of the type.
Parameters
valueThe type.

Definition at line 47 of file jade.lemke.hpp.

49  {
50  switch (value)
51  {
52  #define CASE(E) case E: return #E; break
53  CASE(executing);
54  CASE(completed);
56  CASE(aborted_elimination);
57  CASE(aborted_pivot);
58  #undef CASE
59  }
60 
61  return nullptr;
62  }
+ Here is the caller graph for this function:

The documentation for this struct was generated from the following file:
jade::basic_lemke::state::aborted_pivot
@ aborted_pivot
Aborted finding the pivot.
Definition: jade.lemke.hpp:41
jade::basic_lemke::state::aborted_initialization
@ aborted_initialization
Aborted during initialization.
Definition: jade.lemke.hpp:39
jade::basic_lemke::state::completed
@ completed
The algorithm completed.
Definition: jade.lemke.hpp:38
jade::basic_lemke::state::executing
@ executing
The algorithm is executing.
Definition: jade.lemke.hpp:37
jade::basic_lemke::state::aborted_elimination
@ aborted_elimination
Aborted with an invalid pivot.
Definition: jade.lemke.hpp:40