ʻOhana
Population structure, admixture history, and selection using learning methods.
Public Types | Public Member Functions | Static Public Attributes
jade::basic_options< TValue > Class Template Reference

A template for a class encapsulating the program options. More...

#include <jade.options.hpp>

+ Inheritance diagram for jade::basic_options< TValue >:
+ Collaboration diagram for jade::basic_options< TValue >:

Public Types

typedef TValue value_type
 The value type. More...
 
typedef std::random_device::result_type seed_type
 The random number generator seed type. More...
 
typedef TValue value_type
 The value type. More...
 
typedef TValue value_type
 The value type. More...
 
typedef std::random_device::result_type seed_type
 The random number generator seed type. More...
 

Public Member Functions

 basic_options (args &a)
 Initializes a new instance of the class. More...
 
value_type get_epsilon () const
 
value_type get_f_epsilon () const
 
const std::string & get_fin () const
 
const std::string & get_fin_force () const
 
const std::string & get_force () const
 
const std::string & get_fout () const
 
size_t get_ksize () const
 
size_t get_max_iterations () const
 
double get_max_time () const
 
const std::string & get_qin () const
 
const std::string & get_qout () const
 
seed_type get_seed () const
 
bool is_epsilon_specified () const
 
bool is_frb () const
 
bool is_fin_specified () const
 
bool is_fin_force_specified () const
 
bool is_fixed_f () const
 
bool is_fixed_q () const
 
bool is_force_specified () const
 
bool is_fout_specified () const
 
bool is_ksize_specified () const
 
bool is_max_iterations_specified () const
 
bool is_max_time_specified () const
 
bool is_qin_specified () const
 
bool is_qout_specified () const
 
bool is_quiet () const
 
 basic_options (args &a)
 Initializes a new instance of the class. More...
 
const std::string & get_ain () const
 
const std::string & get_cin () const
 
const std::string & get_cout () const
 
value_type get_epsilon () const
 
value_type get_f_epsilon () const
 
size_t get_max_iterations () const
 
double get_max_time () const
 
const std::string & get_tin () const
 
const std::string & get_tout () const
 
bool is_ain_specified () const
 
bool is_cin_specified () const
 
bool is_cout_specified () const
 
bool is_epsilon_specified () const
 
bool is_max_iterations_specified () const
 
bool is_max_time_specified () const
 
bool is_tin_specified () const
 
bool is_tout_specified () const
 
 basic_options (args &a)
 Initializes a new instance of the class. More...
 
value_type get_epsilon () const
 
value_type get_f_epsilon () const
 
const std::string & get_fin () const
 
const std::string & get_fin_force () const
 
const std::string & get_force () const
 
const std::string & get_fout () const
 
size_t get_ksize () const
 
size_t get_max_iterations () const
 
double get_max_time () const
 
const std::string & get_qin () const
 
const std::string & get_qout () const
 
seed_type get_seed () const
 
bool is_epsilon_specified () const
 
bool is_frb () const
 
bool is_fin_specified () const
 
bool is_fin_force_specified () const
 
bool is_fixed_f () const
 
bool is_fixed_q () const
 
bool is_force_specified () const
 
bool is_fout_specified () const
 
bool is_ksize_specified () const
 
bool is_max_iterations_specified () const
 
bool is_max_time_specified () const
 
bool is_qin_specified () const
 
bool is_qout_specified () const
 
bool is_quiet () const
 

Static Public Attributes

static constexpr auto no_epsilon
 The value assigned for no –epsilon option. More...
 
static constexpr auto no_ksize
 The value assigned for no –ksize option. More...
 
static constexpr auto no_max_iterations
 The value assigned for no –max-iterations option. More...
 
static constexpr auto no_max_time
 The value assigned for no –max-time option. More...
 
static constexpr auto no_iterations
 The value assigned with no –max-iterations option. More...
 
static constexpr auto no_time
 The value assigned with no –max-time option. More...
 

Detailed Description

template<typename TValue>
class jade::basic_options< TValue >

A template for a class encapsulating the program options.

A template for a class that reads the command-line arguments.

Definition at line 18 of file cpax/jade.options.hpp.

Member Typedef Documentation

◆ seed_type [1/2]

template<typename TValue >
typedef std::random_device::result_type jade::basic_options< TValue >::seed_type

The random number generator seed type.

Definition at line 25 of file cpax/jade.options.hpp.

◆ seed_type [2/2]

template<typename TValue >
typedef std::random_device::result_type jade::basic_options< TValue >::seed_type

The random number generator seed type.

Definition at line 25 of file qpas/jade.options.hpp.

◆ value_type [1/3]

template<typename TValue >
typedef TValue jade::basic_options< TValue >::value_type

The value type.

Definition at line 22 of file cpax/jade.options.hpp.

◆ value_type [2/3]

template<typename TValue >
typedef TValue jade::basic_options< TValue >::value_type

The value type.

Definition at line 22 of file nemeco/jade.options.hpp.

◆ value_type [3/3]

template<typename TValue >
typedef TValue jade::basic_options< TValue >::value_type

The value type.

Definition at line 22 of file qpas/jade.options.hpp.

Constructor & Destructor Documentation

◆ basic_options() [1/3]

template<typename TValue >
jade::basic_options< TValue >::basic_options ( args &  a)
inlineexplicit

Initializes a new instance of the class.

Parameters
aThe command-line arguments.

Definition at line 46 of file cpax/jade.options.hpp.

48  : _epsilon (a.read("--epsilon", "-e", no_epsilon))
49  , _f_epsilon (a.read("--f-epsilon", "-fe", value_type(1.0e-6)))
50  , _fin (a.read<std::string>("--fin", "-fi"))
51  , _fin_force (a.read<std::string>("--fin-force", "-fif"))
52  , _force (a.read<std::string>("--force", "-fg"))
53  , _fout (a.read<std::string>("--fout", "-fo"))
54  , _ksize (a.read("--ksize", "-k", no_ksize))
55  , _max_iterations (a.read("--max-iterations", "-mi", no_max_iterations))
56  , _max_time (a.read("--max-time", "-mt", no_max_time))
57  , _qin (a.read<std::string>("--qin", "-qi"))
58  , _qout (a.read<std::string>("--qout", "-qo"))
59  , _seed (a.read("--seed", "-s", std::random_device()()))
60  , _frb (a.read_flag("--frequency-bounds", "-frb"))
61  , _fixed_f (a.read_flag("--fixed-f", "-ff"))
62  , _fixed_q (a.read_flag("--fixed-q", "-fq"))
63  , _quiet (a.read_flag("--quiet", "-q"))
64  {
65  if (is_epsilon_specified() && _epsilon < value_type(0))
66  throw error()
67  << "invalid value for --epsilon option: "
68  << _epsilon;
69 
70  if (!(_f_epsilon > value_type(0.0) &&
71  _f_epsilon < value_type(0.1)))
72  {
73  throw error()
74  << "invalid value for --f-epsilon option: "
75  << _f_epsilon;
76  }
77 
78  if (is_ksize_specified() && _ksize < 2)
79  throw error()
80  << "invalid value for --ksize option: "
81  << _ksize;
82 
83  if (is_max_time_specified() && _max_time < 0.0)
84  throw error()
85  << "invalid value for --max-time option: "
86  << _max_time;
87 
88  if (!is_ksize_specified() &&
89  !is_qin_specified() &&
90  !is_fin_specified() &&
91  !is_force_specified())
92  {
93  throw error()
94  << "at least one of --ksize, --qin, --fin, or --force must "
95  << "be specified in order to determine the number of "
96  << "components";
97  }
98 
99  if (is_fin_specified() && is_fin_force_specified())
100  throw error() << "invalid specification of --fin option "
101  << "with --fin-force option";
102 
103  if (!is_fin_specified() && _fixed_f)
104  throw error() << "invalid specification of --fixed-f option "
105  << "without --fin option";
106 
107  if (!is_qin_specified() && _fixed_q)
108  throw error() << "invalid specification of --fixed-q option "
109  << "without --qin option";
110 
111  if (is_force_specified() && _fixed_q)
112  throw error() << "invalid specification of --fixed-q option "
113  << "and --force option";
114 
115  if (is_frb())
116  {
117  if (is_fin_force_specified())
118  throw error()
119  << "invalid specification of --fin-force "
120  << "and --frequency-bounds options";
121 
122  if (is_fixed_f() && is_fin_specified())
123  throw error()
124  << "invalid specification of --fixed-f, --fin, "
125  << "and --frequency-bounds options";
126  }
127  }

◆ basic_options() [2/3]

template<typename TValue >
jade::basic_options< TValue >::basic_options ( args &  a)
inlineexplicit

Initializes a new instance of the class.

Parameters
aThe command-line arguments.

Definition at line 39 of file nemeco/jade.options.hpp.

41  : _ain (a.read<std::string>("--ain", "-ai"))
42  , _cin (a.read<std::string>("--cin", "-ci"))
43  , _cout (a.read<std::string>("--cout", "-co"))
44  , _epsilon (a.read("--epsilon", "-e", no_epsilon))
45  , _f_epsilon (a.read("--f-epsilon", "-fe", value_type(1.0e-6)))
46  , _max_iterations (a.read("--max-iterations", "-mi", no_iterations))
47  , _max_time (a.read("--max-time", "-mt", no_time))
48  , _tin (a.read<std::string>("--tin", "-ti"))
49  , _tout (a.read<std::string>("--tout", "-to"))
50  {
51  if (is_epsilon_specified() && _epsilon < value_type(0))
52  throw error()
53  << "invalid value for --epsilon option: " << _epsilon;
54 
55  if (!(_f_epsilon > value_type(0.0) &&
56  _f_epsilon < value_type(0.1)))
57  {
58  throw error()
59  << "invalid value for --f-epsilon option: "
60  << _f_epsilon;
61  }
62 
63  if (is_max_time_specified() && _max_time < 0.0)
64  throw error()
65  << "invalid value for --max-time option: " << _max_time;
66 
67  if (is_max_iterations_specified() && _max_iterations == 0)
68  throw error()
69  << "invalid number of iterations for --max-iterations "
70  << "option: " << _max_iterations;
71 
72  if (!is_tin_specified() && is_tout_specified())
73  throw error("invalid specification of --tout option "
74  "without --tin option");
75 
76  if ((is_ain_specified() ? 1 : 0) +
77  (is_cin_specified() ? 1 : 0) +
78  (is_tin_specified() ? 1 : 0) > 1)
79  throw error("only one of --ain, --cin, and --tin options may "
80  "be specified");
81  }

◆ basic_options() [3/3]

template<typename TValue >
jade::basic_options< TValue >::basic_options ( args &  a)
inlineexplicit

Initializes a new instance of the class.

Parameters
aThe command-line arguments.

Definition at line 46 of file qpas/jade.options.hpp.

48  : _epsilon (a.read("--epsilon", "-e", no_epsilon))
49  , _f_epsilon (a.read("--f-epsilon", "-fe", value_type(1.0e-6)))
50  , _fin (a.read<std::string>("--fin", "-fi"))
51  , _fin_force (a.read<std::string>("--fin-force", "-fif"))
52  , _force (a.read<std::string>("--force", "-fg"))
53  , _fout (a.read<std::string>("--fout", "-fo"))
54  , _ksize (a.read("--ksize", "-k", no_ksize))
55  , _max_iterations (a.read("--max-iterations", "-mi", no_max_iterations))
56  , _max_time (a.read("--max-time", "-mt", no_max_time))
57  , _qin (a.read<std::string>("--qin", "-qi"))
58  , _qout (a.read<std::string>("--qout", "-qo"))
59  , _seed (a.read("--seed", "-s", std::random_device()()))
60  , _frb (a.read_flag("--frequency-bounds", "-frb"))
61  , _fixed_f (a.read_flag("--fixed-f", "-ff"))
62  , _fixed_q (a.read_flag("--fixed-q", "-fq"))
63  , _quiet (a.read_flag("--quiet", "-q"))
64  {
65  if (is_epsilon_specified() && _epsilon < value_type(0))
66  throw error()
67  << "invalid value for --epsilon option: "
68  << _epsilon;
69 
70  if (!(_f_epsilon > value_type(0.0) &&
71  _f_epsilon < value_type(0.1)))
72  {
73  throw error()
74  << "invalid value for --f-epsilon option: "
75  << _f_epsilon;
76  }
77 
78  if (is_ksize_specified() && _ksize < 2)
79  throw error()
80  << "invalid value for --ksize option: "
81  << _ksize;
82 
83  if (is_max_time_specified() && _max_time < 0.0)
84  throw error()
85  << "invalid value for --max-time option: "
86  << _max_time;
87 
88  if (!is_ksize_specified() &&
89  !is_qin_specified() &&
90  !is_fin_specified() &&
91  !is_force_specified())
92  {
93  throw error()
94  << "at least one of --ksize, --qin, --fin, or --force must "
95  << "be specified in order to determine the number of "
96  << "components";
97  }
98 
99  if (is_fin_specified() && is_fin_force_specified())
100  throw error() << "invalid specification of --fin option "
101  << "with --fin-force option";
102 
103  if (!is_fin_specified() && _fixed_f)
104  throw error() << "invalid specification of --fixed-f option "
105  << "without --fin option";
106 
107  if (!is_qin_specified() && _fixed_q)
108  throw error() << "invalid specification of --fixed-q option "
109  << "without --qin option";
110 
111  if (is_force_specified() && _fixed_q)
112  throw error() << "invalid specification of --fixed-q option "
113  << "and --force option";
114 
115  if (is_frb())
116  {
117  if (is_fin_force_specified())
118  throw error()
119  << "invalid specification of --fin-force "
120  << "and --frequency-bounds options";
121 
122  if (is_fixed_f() && is_fin_specified())
123  throw error()
124  << "invalid specification of --fixed-f, --fin, "
125  << "and --frequency-bounds options";
126  }
127  }

Member Function Documentation

◆ get_ain()

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_ain ( ) const
inline
Returns
The admixture graph input path, if specified.

Definition at line 86 of file nemeco/jade.options.hpp.

87  {
88  assert(is_ain_specified());
89  return _ain;
90  }
+ Here is the caller graph for this function:

◆ get_cin()

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_cin ( ) const
inline
Returns
The C input matrix path, if specified.

Definition at line 95 of file nemeco/jade.options.hpp.

96  {
97  assert(is_cin_specified());
98  return _cin;
99  }
+ Here is the caller graph for this function:

◆ get_cout()

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_cout ( ) const
inline
Returns
The C output matrix path, if specified.

Definition at line 104 of file nemeco/jade.options.hpp.

105  {
106  assert(is_cout_specified());
107  return _cout;
108  }
+ Here is the caller graph for this function:

◆ get_epsilon() [1/3]

template<typename TValue >
value_type jade::basic_options< TValue >::get_epsilon ( ) const
inline
Returns
The epsilon value.

Definition at line 132 of file cpax/jade.options.hpp.

133  {
134  assert(is_epsilon_specified());
135  return _epsilon;
136  }

◆ get_epsilon() [2/3]

template<typename TValue >
value_type jade::basic_options< TValue >::get_epsilon ( ) const
inline
Returns
The epsilon value.

Definition at line 113 of file nemeco/jade.options.hpp.

114  {
115  assert(is_epsilon_specified());
116  return _epsilon;
117  }

◆ get_epsilon() [3/3]

template<typename TValue >
value_type jade::basic_options< TValue >::get_epsilon ( ) const
inline
Returns
The epsilon value.

Definition at line 132 of file qpas/jade.options.hpp.

133  {
134  assert(is_epsilon_specified());
135  return _epsilon;
136  }

◆ get_f_epsilon() [1/3]

template<typename TValue >
value_type jade::basic_options< TValue >::get_f_epsilon ( ) const
inline
Returns
The F epsilon value.

Definition at line 141 of file cpax/jade.options.hpp.

142  {
143  return _f_epsilon;
144  }
+ Here is the caller graph for this function:

◆ get_f_epsilon() [2/3]

template<typename TValue >
value_type jade::basic_options< TValue >::get_f_epsilon ( ) const
inline
Returns
The F epsilon value.

Definition at line 122 of file nemeco/jade.options.hpp.

123  {
124  return _f_epsilon;
125  }

◆ get_f_epsilon() [3/3]

template<typename TValue >
value_type jade::basic_options< TValue >::get_f_epsilon ( ) const
inline
Returns
The F epsilon value.

Definition at line 141 of file qpas/jade.options.hpp.

142  {
143  return _f_epsilon;
144  }

◆ get_fin() [1/2]

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_fin ( ) const
inline
Returns
The fin value.

Definition at line 149 of file cpax/jade.options.hpp.

150  {
151  assert(is_fin_specified());
152  return _fin;
153  }
+ Here is the caller graph for this function:

◆ get_fin() [2/2]

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_fin ( ) const
inline
Returns
The fin value.

Definition at line 149 of file qpas/jade.options.hpp.

150  {
151  assert(is_fin_specified());
152  return _fin;
153  }

◆ get_fin_force() [1/2]

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_fin_force ( ) const
inline
Returns
The fin-force value. /

Definition at line 158 of file cpax/jade.options.hpp.

159  {
160  assert(is_fin_force_specified());
161  return _fin_force;
162  }
+ Here is the caller graph for this function:

◆ get_fin_force() [2/2]

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_fin_force ( ) const
inline
Returns
The fin-force value. /

Definition at line 158 of file qpas/jade.options.hpp.

159  {
160  assert(is_fin_force_specified());
161  return _fin_force;
162  }

◆ get_force() [1/2]

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_force ( ) const
inline
Returns
The force value.

Definition at line 167 of file cpax/jade.options.hpp.

168  {
169  assert(is_force_specified());
170  return _force;
171  }
+ Here is the caller graph for this function:

◆ get_force() [2/2]

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_force ( ) const
inline
Returns
The force value.

Definition at line 167 of file qpas/jade.options.hpp.

168  {
169  assert(is_force_specified());
170  return _force;
171  }

◆ get_fout() [1/2]

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_fout ( ) const
inline
Returns
The fout value.

Definition at line 176 of file cpax/jade.options.hpp.

177  {
178  assert(is_fout_specified());
179  return _fout;
180  }

◆ get_fout() [2/2]

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_fout ( ) const
inline
Returns
The fout value.

Definition at line 176 of file qpas/jade.options.hpp.

177  {
178  assert(is_fout_specified());
179  return _fout;
180  }

◆ get_ksize() [1/2]

template<typename TValue >
size_t jade::basic_options< TValue >::get_ksize ( ) const
inline
Returns
The ksize value.

Definition at line 185 of file cpax/jade.options.hpp.

186  {
187  assert(is_ksize_specified());
188  return _ksize;
189  }
+ Here is the caller graph for this function:

◆ get_ksize() [2/2]

template<typename TValue >
size_t jade::basic_options< TValue >::get_ksize ( ) const
inline
Returns
The ksize value.

Definition at line 185 of file qpas/jade.options.hpp.

186  {
187  assert(is_ksize_specified());
188  return _ksize;
189  }

◆ get_max_iterations() [1/3]

template<typename TValue >
size_t jade::basic_options< TValue >::get_max_iterations ( ) const
inline
Returns
The maximum iterations value.

Definition at line 194 of file cpax/jade.options.hpp.

195  {
196  assert(is_max_iterations_specified());
197  return _max_iterations;
198  }

◆ get_max_iterations() [2/3]

template<typename TValue >
size_t jade::basic_options< TValue >::get_max_iterations ( ) const
inline
Returns
The maximum number of iterations.

Definition at line 130 of file nemeco/jade.options.hpp.

131  {
132  assert(is_max_iterations_specified());
133  return _max_iterations;
134  }

◆ get_max_iterations() [3/3]

template<typename TValue >
size_t jade::basic_options< TValue >::get_max_iterations ( ) const
inline
Returns
The maximum iterations value.

Definition at line 194 of file qpas/jade.options.hpp.

195  {
196  assert(is_max_iterations_specified());
197  return _max_iterations;
198  }

◆ get_max_time() [1/3]

template<typename TValue >
double jade::basic_options< TValue >::get_max_time ( ) const
inline
Returns
The maximum time value.

Definition at line 203 of file cpax/jade.options.hpp.

204  {
205  assert(is_max_time_specified());
206  return _max_time;
207  }

◆ get_max_time() [2/3]

template<typename TValue >
double jade::basic_options< TValue >::get_max_time ( ) const
inline
Returns
The maximum amount of time to execute.

Definition at line 139 of file nemeco/jade.options.hpp.

140  {
141  assert(is_max_time_specified());
142  return _max_time;
143  }

◆ get_max_time() [3/3]

template<typename TValue >
double jade::basic_options< TValue >::get_max_time ( ) const
inline
Returns
The maximum time value.

Definition at line 203 of file qpas/jade.options.hpp.

204  {
205  assert(is_max_time_specified());
206  return _max_time;
207  }

◆ get_qin() [1/2]

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_qin ( ) const
inline
Returns
The qin value.

Definition at line 212 of file cpax/jade.options.hpp.

213  {
214  assert(is_qin_specified());
215  return _qin;
216  }
+ Here is the caller graph for this function:

◆ get_qin() [2/2]

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_qin ( ) const
inline
Returns
The qin value.

Definition at line 212 of file qpas/jade.options.hpp.

213  {
214  assert(is_qin_specified());
215  return _qin;
216  }

◆ get_qout() [1/2]

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_qout ( ) const
inline
Returns
The qout value.

Definition at line 221 of file cpax/jade.options.hpp.

222  {
223  assert(is_qout_specified());
224  return _qout;
225  }

◆ get_qout() [2/2]

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_qout ( ) const
inline
Returns
The qout value.

Definition at line 221 of file qpas/jade.options.hpp.

222  {
223  assert(is_qout_specified());
224  return _qout;
225  }

◆ get_seed() [1/2]

template<typename TValue >
seed_type jade::basic_options< TValue >::get_seed ( ) const
inline
Returns
The seed value.

Definition at line 230 of file cpax/jade.options.hpp.

231  {
232  return _seed;
233  }
+ Here is the caller graph for this function:

◆ get_seed() [2/2]

template<typename TValue >
seed_type jade::basic_options< TValue >::get_seed ( ) const
inline
Returns
The seed value.

Definition at line 230 of file qpas/jade.options.hpp.

231  {
232  return _seed;
233  }

◆ get_tin()

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_tin ( ) const
inline
Returns
The T input tree path, if specified.

Definition at line 148 of file nemeco/jade.options.hpp.

149  {
150  assert(is_tin_specified());
151  return _tin;
152  }
+ Here is the caller graph for this function:

◆ get_tout()

template<typename TValue >
const std::string& jade::basic_options< TValue >::get_tout ( ) const
inline
Returns
The T output tree path, if specified.

Definition at line 157 of file nemeco/jade.options.hpp.

158  {
159  assert(is_tout_specified());
160  return _tout;
161  }
+ Here is the caller graph for this function:

◆ is_ain_specified()

template<typename TValue >
bool jade::basic_options< TValue >::is_ain_specified ( ) const
inline
Returns
True if the admixture graph input file was specified.

Definition at line 166 of file nemeco/jade.options.hpp.

167  {
168  return !_ain.empty();
169  }
+ Here is the caller graph for this function:

◆ is_cin_specified()

template<typename TValue >
bool jade::basic_options< TValue >::is_cin_specified ( ) const
inline
Returns
True if the C input matrix was specified.

Definition at line 174 of file nemeco/jade.options.hpp.

175  {
176  return !_cin.empty();
177  }
+ Here is the caller graph for this function:

◆ is_cout_specified()

template<typename TValue >
bool jade::basic_options< TValue >::is_cout_specified ( ) const
inline
Returns
True if the C output matrix was specified.

Definition at line 182 of file nemeco/jade.options.hpp.

183  {
184  return !_cout.empty();
185  }
+ Here is the caller graph for this function:

◆ is_epsilon_specified() [1/3]

template<typename TValue >
bool jade::basic_options< TValue >::is_epsilon_specified ( ) const
inline
Returns
True if the epsilon option is specified.

Definition at line 238 of file cpax/jade.options.hpp.

239  {
240  return !std::isnan(_epsilon);
241  }
+ Here is the caller graph for this function:

◆ is_epsilon_specified() [2/3]

template<typename TValue >
bool jade::basic_options< TValue >::is_epsilon_specified ( ) const
inline
Returns
True if the epsilon option was specified.

Definition at line 190 of file nemeco/jade.options.hpp.

191  {
192  return !std::isnan(_epsilon);
193  }

◆ is_epsilon_specified() [3/3]

template<typename TValue >
bool jade::basic_options< TValue >::is_epsilon_specified ( ) const
inline
Returns
True if the epsilon option is specified.

Definition at line 238 of file qpas/jade.options.hpp.

239  {
240  return !std::isnan(_epsilon);
241  }

◆ is_fin_force_specified() [1/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_fin_force_specified ( ) const
inline
Returns
True if the fin-force option is specified.

Definition at line 262 of file cpax/jade.options.hpp.

263  {
264  return !_fin_force.empty();
265  }
+ Here is the caller graph for this function:

◆ is_fin_force_specified() [2/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_fin_force_specified ( ) const
inline
Returns
True if the fin-force option is specified.

Definition at line 262 of file qpas/jade.options.hpp.

263  {
264  return !_fin_force.empty();
265  }

◆ is_fin_specified() [1/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_fin_specified ( ) const
inline
Returns
True if the fin option is specified.

Definition at line 254 of file cpax/jade.options.hpp.

255  {
256  return !_fin.empty();
257  }
+ Here is the caller graph for this function:

◆ is_fin_specified() [2/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_fin_specified ( ) const
inline
Returns
True if the fin option is specified.

Definition at line 254 of file qpas/jade.options.hpp.

255  {
256  return !_fin.empty();
257  }

◆ is_fixed_f() [1/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_fixed_f ( ) const
inline
Returns
The fixed F value.

Definition at line 270 of file cpax/jade.options.hpp.

271  {
272  return _fixed_f;
273  }
+ Here is the caller graph for this function:

◆ is_fixed_f() [2/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_fixed_f ( ) const
inline
Returns
The fixed F value.

Definition at line 270 of file qpas/jade.options.hpp.

271  {
272  return _fixed_f;
273  }

◆ is_fixed_q() [1/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_fixed_q ( ) const
inline
Returns
The fixed Q value.

Definition at line 278 of file cpax/jade.options.hpp.

279  {
280  return _fixed_q;
281  }

◆ is_fixed_q() [2/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_fixed_q ( ) const
inline
Returns
The fixed Q value.

Definition at line 278 of file qpas/jade.options.hpp.

279  {
280  return _fixed_q;
281  }

◆ is_force_specified() [1/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_force_specified ( ) const
inline
Returns
True if the force option is specified.

Definition at line 286 of file cpax/jade.options.hpp.

287  {
288  return !_force.empty();
289  }
+ Here is the caller graph for this function:

◆ is_force_specified() [2/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_force_specified ( ) const
inline
Returns
True if the force option is specified.

Definition at line 286 of file qpas/jade.options.hpp.

287  {
288  return !_force.empty();
289  }

◆ is_fout_specified() [1/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_fout_specified ( ) const
inline
Returns
True if the fout option is specified.

Definition at line 294 of file cpax/jade.options.hpp.

295  {
296  return !_fout.empty();
297  }
+ Here is the caller graph for this function:

◆ is_fout_specified() [2/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_fout_specified ( ) const
inline
Returns
True if the fout option is specified.

Definition at line 294 of file qpas/jade.options.hpp.

295  {
296  return !_fout.empty();
297  }

◆ is_frb() [1/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_frb ( ) const
inline
Returns
True if the frequency-bounds option is specified.

Definition at line 246 of file cpax/jade.options.hpp.

247  {
248  return _frb;
249  }
+ Here is the caller graph for this function:

◆ is_frb() [2/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_frb ( ) const
inline
Returns
True if the frequency-bounds option is specified.

Definition at line 246 of file qpas/jade.options.hpp.

247  {
248  return _frb;
249  }

◆ is_ksize_specified() [1/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_ksize_specified ( ) const
inline
Returns
True if the ksize option is specified.

Definition at line 302 of file cpax/jade.options.hpp.

303  {
304  return _ksize != no_ksize;
305  }
+ Here is the caller graph for this function:

◆ is_ksize_specified() [2/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_ksize_specified ( ) const
inline
Returns
True if the ksize option is specified.

Definition at line 302 of file qpas/jade.options.hpp.

303  {
304  return _ksize != no_ksize;
305  }

◆ is_max_iterations_specified() [1/3]

template<typename TValue >
bool jade::basic_options< TValue >::is_max_iterations_specified ( ) const
inline
Returns
True if the maximum iterations option is specified.

Definition at line 310 of file cpax/jade.options.hpp.

311  {
312  return _max_iterations != no_max_iterations;
313  }
+ Here is the caller graph for this function:

◆ is_max_iterations_specified() [2/3]

template<typename TValue >
bool jade::basic_options< TValue >::is_max_iterations_specified ( ) const
inline
Returns
True if the maximum iterations option was specified.

Definition at line 198 of file nemeco/jade.options.hpp.

199  {
200  return _max_iterations != no_iterations;
201  }

◆ is_max_iterations_specified() [3/3]

template<typename TValue >
bool jade::basic_options< TValue >::is_max_iterations_specified ( ) const
inline
Returns
True if the maximum iterations option is specified.

Definition at line 310 of file qpas/jade.options.hpp.

311  {
312  return _max_iterations != no_max_iterations;
313  }

◆ is_max_time_specified() [1/3]

template<typename TValue >
bool jade::basic_options< TValue >::is_max_time_specified ( ) const
inline
Returns
True if the maximum time option is specified.

Definition at line 318 of file cpax/jade.options.hpp.

319  {
320  return !std::isnan(_max_time);
321  }
+ Here is the caller graph for this function:

◆ is_max_time_specified() [2/3]

template<typename TValue >
bool jade::basic_options< TValue >::is_max_time_specified ( ) const
inline
Returns
True if the maximum time option was specified.

Definition at line 206 of file nemeco/jade.options.hpp.

207  {
208  return !std::isnan(_max_time);
209  }

◆ is_max_time_specified() [3/3]

template<typename TValue >
bool jade::basic_options< TValue >::is_max_time_specified ( ) const
inline
Returns
True if the maximum time option is specified.

Definition at line 318 of file qpas/jade.options.hpp.

319  {
320  return !std::isnan(_max_time);
321  }

◆ is_qin_specified() [1/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_qin_specified ( ) const
inline
Returns
True if the qin option is specified.

Definition at line 326 of file cpax/jade.options.hpp.

327  {
328  return !_qin.empty();
329  }
+ Here is the caller graph for this function:

◆ is_qin_specified() [2/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_qin_specified ( ) const
inline
Returns
True if the qin option is specified.

Definition at line 326 of file qpas/jade.options.hpp.

327  {
328  return !_qin.empty();
329  }

◆ is_qout_specified() [1/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_qout_specified ( ) const
inline
Returns
True if the qout option is specified.

Definition at line 334 of file cpax/jade.options.hpp.

335  {
336  return !_qout.empty();
337  }
+ Here is the caller graph for this function:

◆ is_qout_specified() [2/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_qout_specified ( ) const
inline
Returns
True if the qout option is specified.

Definition at line 334 of file qpas/jade.options.hpp.

335  {
336  return !_qout.empty();
337  }

◆ is_quiet() [1/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_quiet ( ) const
inline
Returns
The quiet value.

Definition at line 342 of file cpax/jade.options.hpp.

343  {
344  return _quiet;
345  }

◆ is_quiet() [2/2]

template<typename TValue >
bool jade::basic_options< TValue >::is_quiet ( ) const
inline
Returns
The quiet value.

Definition at line 342 of file qpas/jade.options.hpp.

343  {
344  return _quiet;
345  }

◆ is_tin_specified()

template<typename TValue >
bool jade::basic_options< TValue >::is_tin_specified ( ) const
inline
Returns
True if the T input tree was specified.

Definition at line 214 of file nemeco/jade.options.hpp.

215  {
216  return !_tin.empty();
217  }
+ Here is the caller graph for this function:

◆ is_tout_specified()

template<typename TValue >
bool jade::basic_options< TValue >::is_tout_specified ( ) const
inline
Returns
True if the T output tree was specified.

Definition at line 222 of file nemeco/jade.options.hpp.

223  {
224  return !_tout.empty();
225  }
+ Here is the caller graph for this function:

Field Documentation

◆ no_epsilon

template<typename TValue >
static constexpr auto jade::basic_options< TValue >::no_epsilon
staticconstexpr
Initial value:
=
std::numeric_limits<value_type>::quiet_NaN()

The value assigned for no –epsilon option.

The value assigned with no –epsilon option.

Definition at line 28 of file cpax/jade.options.hpp.

◆ no_iterations

template<typename TValue >
constexpr auto jade::basic_options< TValue >::no_iterations
staticconstexpr
Initial value:
=
std::numeric_limits<size_t>::max()

The value assigned with no –max-iterations option.

Definition at line 29 of file nemeco/jade.options.hpp.

◆ no_ksize

template<typename TValue >
static constexpr auto jade::basic_options< TValue >::no_ksize
staticconstexpr
Initial value:
=
std::numeric_limits<size_t>::max()

The value assigned for no –ksize option.

Definition at line 32 of file cpax/jade.options.hpp.

◆ no_max_iterations

template<typename TValue >
static constexpr auto jade::basic_options< TValue >::no_max_iterations
staticconstexpr
Initial value:
=
std::numeric_limits<size_t>::max()

The value assigned for no –max-iterations option.

Definition at line 36 of file cpax/jade.options.hpp.

◆ no_max_time

template<typename TValue >
static constexpr auto jade::basic_options< TValue >::no_max_time
staticconstexpr
Initial value:
=
std::numeric_limits<double>::quiet_NaN()

The value assigned for no –max-time option.

Definition at line 40 of file cpax/jade.options.hpp.

◆ no_time

template<typename TValue >
constexpr auto jade::basic_options< TValue >::no_time
staticconstexpr
Initial value:
=
std::numeric_limits<double>::quiet_NaN()

The value assigned with no –max-time option.

Definition at line 33 of file nemeco/jade.options.hpp.

The documentation for this class was generated from the following file:
jade::basic_options::is_ksize_specified
bool is_ksize_specified() const
Definition: cpax/jade.options.hpp:302
jade::basic_options::is_max_iterations_specified
bool is_max_iterations_specified() const
Definition: cpax/jade.options.hpp:310
jade::basic_options::is_cout_specified
bool is_cout_specified() const
Definition: nemeco/jade.options.hpp:182
jade::basic_options::is_fin_force_specified
bool is_fin_force_specified() const
Definition: cpax/jade.options.hpp:262
jade::basic_options::is_epsilon_specified
bool is_epsilon_specified() const
Definition: cpax/jade.options.hpp:238
jade::basic_options::no_epsilon
static constexpr auto no_epsilon
The value assigned for no –epsilon option.
Definition: cpax/jade.options.hpp:28
jade::basic_options::is_max_time_specified
bool is_max_time_specified() const
Definition: cpax/jade.options.hpp:318
jade::basic_options::is_tin_specified
bool is_tin_specified() const
Definition: nemeco/jade.options.hpp:214
jade::basic_options::is_tout_specified
bool is_tout_specified() const
Definition: nemeco/jade.options.hpp:222
jade::basic_options::no_max_iterations
static constexpr auto no_max_iterations
The value assigned for no –max-iterations option.
Definition: cpax/jade.options.hpp:36
jade::basic_options::is_ain_specified
bool is_ain_specified() const
Definition: nemeco/jade.options.hpp:166
jade::basic_options::no_ksize
static constexpr auto no_ksize
The value assigned for no –ksize option.
Definition: cpax/jade.options.hpp:32
jade::basic_options::no_time
static constexpr auto no_time
The value assigned with no –max-time option.
Definition: nemeco/jade.options.hpp:33
jade::basic_options::is_fout_specified
bool is_fout_specified() const
Definition: cpax/jade.options.hpp:294
jade::basic_options::is_fixed_f
bool is_fixed_f() const
Definition: cpax/jade.options.hpp:270
jade::basic_options::no_iterations
static constexpr auto no_iterations
The value assigned with no –max-iterations option.
Definition: nemeco/jade.options.hpp:29
jade::basic_options::no_max_time
static constexpr auto no_max_time
The value assigned for no –max-time option.
Definition: cpax/jade.options.hpp:40
jade::basic_options::is_fin_specified
bool is_fin_specified() const
Definition: cpax/jade.options.hpp:254
jade::basic_options::is_cin_specified
bool is_cin_specified() const
Definition: nemeco/jade.options.hpp:174
jade::basic_options::is_force_specified
bool is_force_specified() const
Definition: cpax/jade.options.hpp:286
jade::basic_options::is_qin_specified
bool is_qin_specified() const
Definition: cpax/jade.options.hpp:326
jade::basic_options::is_qout_specified
bool is_qout_specified() const
Definition: cpax/jade.options.hpp:334
jade::basic_options::value_type
TValue value_type
The value type.
Definition: cpax/jade.options.hpp:22
jade::basic_options::is_frb
bool is_frb() const
Definition: cpax/jade.options.hpp:246
Copyright © 2015-2020 Jade Cheng