jade::basic_settings< TValue > Class Template Reference

A template for a class encapsulating the settings provided to the optimizer. More...

#include <jade.settings.hpp>

Collaboration diagram for jade::basic_settings< TValue >:

Public Types
typedef TValue	value_type
	The value type. More...
typedef basic_matrix< value_type >	matrix_type
	The matrix type. More...
typedef basic_forced_grouping< value_type >	forced_grouping_type
	The forced grouping type. More...
typedef basic_genotype_matrix< value_type >	genotype_matrix_type
	The genotype matrix. More...
typedef basic_options< value_type >	options_type
	The options type. More...
typedef basic_randomizer< value_type >	randomizer_type
	The randomizer type. More...
typedef basic_verification< value_type >	verification_type
	The verification type. More...
typedef std::unique_ptr< forced_grouping_type >	fg_ptr
	The forced grouping pointer type. More...
typedef std::unique_ptr< matrix_type >	fif_ptr
	The Fin-force pointer type. More...
typedef std::unique_ptr< genotype_matrix_type >	g_ptr
	The genotype matrix pointer type. More...
typedef basic_genotype_matrix_factory< value_type >	g_matrix_factory_type
	The genotype matrix factory type. More...
typedef TValue	value_type
	The value type. More...
typedef basic_agi_reader< value_type >	agi_reader_type
	The admixture graph input reader. More...
typedef std::unique_ptr< agi_reader_type >	agi_ptr_type
	A pointer to an admixture graph input reader. More...
typedef basic_genotype_matrix_factory< value_type >	genotype_matrix_factory_type
	The genotype matrix factory type. More...
typedef basic_genotype_matrix< value_type >	genotype_matrix_type
	The genotype matrix type. More...
typedef basic_matrix< value_type >	matrix_type
	The matrix type. More...
typedef basic_options< value_type >	options_type
	The options type. More...
typedef basic_verification< value_type >	verification_type
	The verification type. More...
typedef TValue	value_type
	The value type. More...
typedef basic_matrix< value_type >	matrix_type
	The matrix type. More...
typedef basic_forced_grouping< value_type >	forced_grouping_type
	The forced grouping type. More...
typedef basic_genotype_matrix< value_type >	genotype_matrix_type
	The genotype matrix. More...
typedef basic_options< value_type >	options_type
	The options type. More...
typedef basic_randomizer< value_type >	randomizer_type
	The randomizer type. More...
typedef basic_verification< value_type >	verification_type
	The verification type. More...
typedef std::unique_ptr< forced_grouping_type >	fg_ptr
	The forced grouping pointer type. More...
typedef std::unique_ptr< matrix_type >	fif_ptr
	The Fin-force pointer type. More...
typedef std::unique_ptr< genotype_matrix_type >	g_ptr
	The genotype matrix pointer type. More...
typedef basic_genotype_matrix_factory< value_type >	g_matrix_factory_type
	The genotype matrix factory type. More...

Public Member Functions
	basic_settings (args &a)
	Initializes a new instance of the class based on the specified arguments. More...
const matrix_type &	get_f () const
matrix_type &	get_f ()
const matrix_type *	get_fif () const
const forced_grouping_type *	get_fg () const
const genotype_matrix_type &	get_g () const
const options_type &	get_options () const
const matrix_type &	get_q () const
matrix_type &	get_q ()
const randomizer_type &	get_randomizer () const
	basic_settings (args &a)
	Initializes a new instance of the class based on the specified command-line arguments. More...
const agi_reader_type &	get_agi () const
const matrix_type &	get_c () const
const matrix_type &	get_mu () const
const options_type &	get_options () const
const matrix_type &	get_rf () const
	basic_settings (args &a)
	Initializes a new instance of the class based on the specified arguments. More...
const matrix_type &	get_f () const
matrix_type &	get_f ()
const matrix_type *	get_fif () const
const forced_grouping_type *	get_fg () const
const genotype_matrix_type &	get_g () const
const options_type &	get_options () const
const matrix_type &	get_q () const
matrix_type &	get_q ()
const randomizer_type &	get_randomizer () const

Static Public Member Functions
static matrix_type	create_c (const matrix_type &rf)
	Creates the covariance matrix. More...
static matrix_type	create_rf (const matrix_type &f)
	Creates the rooted F matrix. More...

Detailed Description

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

A template for a class encapsulating the settings provided to the optimizer.

A template for a class that prepares settings for the algorithm.

Definition at line 21 of file cpax/jade.settings.hpp.

Member Typedef Documentation

agi_ptr_type

template<typename TValue >

typedef std::unique_ptr<agi_reader_type> jade::basic_settings< TValue >::agi_ptr_type

A pointer to an admixture graph input reader.

Definition at line 30 of file nemeco/jade.settings.hpp.

agi_reader_type

template<typename TValue >

typedef basic_agi_reader<value_type> jade::basic_settings< TValue >::agi_reader_type

The admixture graph input reader.

Definition at line 27 of file nemeco/jade.settings.hpp.

fg_ptr [1/2]

template<typename TValue >

typedef std::unique_ptr<forced_grouping_type> jade::basic_settings< TValue >::fg_ptr

The forced grouping pointer type.

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

fg_ptr [2/2]

template<typename TValue >

typedef std::unique_ptr<forced_grouping_type> jade::basic_settings< TValue >::fg_ptr

The forced grouping pointer type.

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

fif_ptr [1/2]

template<typename TValue >

typedef std::unique_ptr<matrix_type> jade::basic_settings< TValue >::fif_ptr

The Fin-force pointer type.

Definition at line 49 of file cpax/jade.settings.hpp.

fif_ptr [2/2]

template<typename TValue >

typedef std::unique_ptr<matrix_type> jade::basic_settings< TValue >::fif_ptr

The Fin-force pointer type.

Definition at line 49 of file qpas/jade.settings.hpp.

forced_grouping_type [1/2]

template<typename TValue >

typedef basic_forced_grouping<value_type> jade::basic_settings< TValue >::forced_grouping_type

The forced grouping type.

Definition at line 31 of file cpax/jade.settings.hpp.

forced_grouping_type [2/2]

template<typename TValue >

typedef basic_forced_grouping<value_type> jade::basic_settings< TValue >::forced_grouping_type

The forced grouping type.

Definition at line 31 of file qpas/jade.settings.hpp.

g_matrix_factory_type [1/2]

template<typename TValue >

typedef basic_genotype_matrix_factory<value_type> jade::basic_settings< TValue >::g_matrix_factory_type

The genotype matrix factory type.

Definition at line 56 of file cpax/jade.settings.hpp.

g_matrix_factory_type [2/2]

template<typename TValue >

typedef basic_genotype_matrix_factory<value_type> jade::basic_settings< TValue >::g_matrix_factory_type

The genotype matrix factory type.

Definition at line 56 of file qpas/jade.settings.hpp.

g_ptr [1/2]

template<typename TValue >

typedef std::unique_ptr<genotype_matrix_type> jade::basic_settings< TValue >::g_ptr

The genotype matrix pointer type.

Definition at line 52 of file cpax/jade.settings.hpp.

g_ptr [2/2]

template<typename TValue >

typedef std::unique_ptr<genotype_matrix_type> jade::basic_settings< TValue >::g_ptr

The genotype matrix pointer type.

Definition at line 52 of file qpas/jade.settings.hpp.

genotype_matrix_factory_type

template<typename TValue >

typedef basic_genotype_matrix_factory<value_type> jade::basic_settings< TValue >::genotype_matrix_factory_type

The genotype matrix factory type.

Definition at line 34 of file nemeco/jade.settings.hpp.

genotype_matrix_type [1/3]

template<typename TValue >

typedef basic_genotype_matrix<value_type> jade::basic_settings< TValue >::genotype_matrix_type

The genotype matrix.

Definition at line 34 of file cpax/jade.settings.hpp.

genotype_matrix_type [2/3]

template<typename TValue >

typedef basic_genotype_matrix<value_type> jade::basic_settings< TValue >::genotype_matrix_type

The genotype matrix type.

Definition at line 37 of file nemeco/jade.settings.hpp.

genotype_matrix_type [3/3]

template<typename TValue >

typedef basic_genotype_matrix<value_type> jade::basic_settings< TValue >::genotype_matrix_type

The genotype matrix.

Definition at line 34 of file qpas/jade.settings.hpp.

matrix_type [1/3]

template<typename TValue >

typedef basic_matrix<value_type> jade::basic_settings< TValue >::matrix_type

The matrix type.

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

matrix_type [2/3]

template<typename TValue >

typedef basic_matrix<value_type> jade::basic_settings< TValue >::matrix_type

The matrix type.

Definition at line 40 of file nemeco/jade.settings.hpp.

matrix_type [3/3]

template<typename TValue >

typedef basic_matrix<value_type> jade::basic_settings< TValue >::matrix_type

The matrix type.

Definition at line 28 of file qpas/jade.settings.hpp.

options_type [1/3]

template<typename TValue >

typedef basic_options<value_type> jade::basic_settings< TValue >::options_type

The options type.

Definition at line 37 of file cpax/jade.settings.hpp.

options_type [2/3]

template<typename TValue >

typedef basic_options<value_type> jade::basic_settings< TValue >::options_type

The options type.

Definition at line 43 of file nemeco/jade.settings.hpp.

options_type [3/3]

template<typename TValue >

typedef basic_options<value_type> jade::basic_settings< TValue >::options_type

The options type.

Definition at line 37 of file qpas/jade.settings.hpp.

randomizer_type [1/2]

template<typename TValue >

typedef basic_randomizer<value_type> jade::basic_settings< TValue >::randomizer_type

The randomizer type.

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

randomizer_type [2/2]

template<typename TValue >

typedef basic_randomizer<value_type> jade::basic_settings< TValue >::randomizer_type

The randomizer type.

Definition at line 40 of file qpas/jade.settings.hpp.

value_type [1/3]

template<typename TValue >

typedef TValue jade::basic_settings< TValue >::value_type

The value type.

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

value_type [2/3]

template<typename TValue >

typedef TValue jade::basic_settings< TValue >::value_type

The value type.

Definition at line 24 of file nemeco/jade.settings.hpp.

value_type [3/3]

template<typename TValue >

typedef TValue jade::basic_settings< TValue >::value_type

The value type.

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

verification_type [1/3]

template<typename TValue >

typedef basic_verification<value_type> jade::basic_settings< TValue >::verification_type

The verification type.

Definition at line 43 of file cpax/jade.settings.hpp.

verification_type [2/3]

template<typename TValue >

typedef basic_verification<value_type> jade::basic_settings< TValue >::verification_type

The verification type.

Definition at line 46 of file nemeco/jade.settings.hpp.

verification_type [3/3]

template<typename TValue >

typedef basic_verification<value_type> jade::basic_settings< TValue >::verification_type

The verification type.

Definition at line 43 of file qpas/jade.settings.hpp.

Constructor & Destructor Documentation

basic_settings() [1/3]

template<typename TValue >

jade::basic_settings< TValue >::basic_settings ( args &  a )

inlineexplicit

Initializes a new instance of the class based on the specified arguments.

Parameters

a	The command-line arguments.

Definition at line 62 of file cpax/jade.settings.hpp.

            : _opts (a)
            , _g    (g_matrix_factory_type::create(a.pop<std::string>()))
            , _q    ()
            , _f    ()
            , _fif  ()
            , _fg   ()
            , _rnd  ()
        {
            verification_type::validate_g(*_g);
 
            a.validate_empty();
 
            if (_opts.is_qin_specified())
            {
                _q.read(_opts.get_qin());
                verification_type::validate_q(_q);
            }
 
            if (_opts.is_fin_specified())
            {
                _f.read(_opts.get_fin());
                verification_type::validate_f(_f);
            }
 
            if (_opts.is_fin_force_specified())
            {
                _fif.reset(new matrix_type(_opts.get_fin_force()));
                verification_type::validate_f(*_fif);
            }
 
            if (_opts.is_force_specified())
                _fg.reset(new forced_grouping_type(_opts.get_force()));
 
            const auto n = _g->get_height();
            const auto k = _opts.is_qin_specified() ? _q.get_width() :
                _opts.is_fin_specified() ? _f.get_height() :
                _opts.is_force_specified() ? _fg->get_k() :
                _opts.get_ksize();
 
            if (_fif)
                verification_type::validate_fif_size(
                    *_fif, k, _g->get_width());
 
            _rnd.get_engine().seed(_opts.get_seed());
 
            if (!_opts.is_qin_specified())
                _q = _opts.is_force_specified()
                        ? _fg->randomize_q(_rnd)
                        : _rnd.randomize_q(n ,k);
 
            if (_opts.is_fin_force_specified())
                _f = _rnd.randomize_f(
                    k,
                    _g->create_mu(_opts.get_f_epsilon()),
                    *_fif);
            else if (!_opts.is_fin_specified())
                _f = _rnd.randomize_f(
                    k,
                    _g->create_mu(_opts.get_f_epsilon()));
 
            verification_type::validate_gqf_sizes(*_g, _q, _f);
 
            if (_opts.is_force_specified())
                _fg->validate_q(_q);
        }

Here is the call graph for this function:

basic_settings() [2/3]

template<typename TValue >

jade::basic_settings< TValue >::basic_settings ( args &  a )

inlineexplicit

Initializes a new instance of the class based on the specified command-line arguments.

Parameters

a	The command-line arguments.

Definition at line 52 of file nemeco/jade.settings.hpp.

            : _opts (a)
            , _agi  ()
            , _f    ()
            , _rf   ()
            , _c    ()
            , _mu   ()
        {
            if (_opts.is_ain_specified())
                _agi.reset(new agi_reader_type(_opts.get_ain()));
 
            const std::unique_ptr<genotype_matrix_type> g_ptr (
                genotype_matrix_factory_type::create(a.pop<std::string>()));
            const auto & g = *g_ptr;
            verification_type::validate_g(g);
 
            _f.read(a.pop<std::string>());
            verification_type::validate_f(_f);
 
            a.validate_empty();
 
            _rf = create_rf(_f);
            _mu = g.create_mu(_opts.get_f_epsilon());
 
            //
            // If the user specifies the C matrix, read it from the file; if
            // the user specifies a tree or the AGI file, do not initialize its
            // values because they will be initialized by the optimizer based
            // on the tree or AGI definitions. If the C matrix, the tree, and
            // the AGI file are unspecified, then create it as the sample
            // covariance matrix of the rooted F matrix.
            //
            if (_opts.is_cin_specified())
            {
                _c.read(_opts.get_cin());
                verification_type::validate_c(_c);
                verification_type::validate_fc_sizes(_f, _c);
            }
            else if (_opts.is_tin_specified())
            {
                const auto rk = _rf.get_height();
                _c.resize(rk, rk);
            }
            else if (_opts.is_ain_specified())
            {
                const auto agi_k = _agi->get_k();
                const auto f_k   = _f.get_height();
 
                if (agi_k != f_k)
                    throw jade::error()
                        << "inconsistent component sizes " << agi_k << " and "
                        << f_k << " in AGI file and F matrix.";
 
                const auto rk = _rf.get_height();
                _c.resize(rk, rk);
            }
            else
            {
                _c = create_c(_rf);
            }
 
            verification_type::validate_gf_sizes(g, _f);
        }

Here is the call graph for this function:

basic_settings() [3/3]

template<typename TValue >

jade::basic_settings< TValue >::basic_settings ( args &  a )

inlineexplicit

Initializes a new instance of the class based on the specified arguments.

Parameters

a	The command-line arguments.

Definition at line 62 of file qpas/jade.settings.hpp.

            : _opts (a)
            , _g    (g_matrix_factory_type::create(a.pop<std::string>()))
            , _q    ()
            , _f    ()
            , _fif  ()
            , _fg   ()
            , _rnd  ()
        {
            verification_type::validate_g(*_g);
 
            a.validate_empty();
 
            if (_opts.is_qin_specified())
            {
                _q.read(_opts.get_qin());
                verification_type::validate_q(_q);
            }
 
            if (_opts.is_fin_specified())
            {
                _f.read(_opts.get_fin());
                verification_type::validate_f(_f);
            }
 
            if (_opts.is_fin_force_specified())
            {
                _fif.reset(new matrix_type(_opts.get_fin_force()));
                verification_type::validate_f(*_fif);
            }
 
            if (_opts.is_force_specified())
                _fg.reset(new forced_grouping_type(_opts.get_force()));
 
            const auto n = _g->get_height();
            const auto k = _opts.is_qin_specified() ? _q.get_width() :
                _opts.is_fin_specified() ? _f.get_height() :
                _opts.is_force_specified() ? _fg->get_k() :
                _opts.get_ksize();
 
            if (_fif)
                verification_type::validate_fif_size(
                    *_fif, k, _g->get_width());
 
            _rnd.get_engine().seed(_opts.get_seed());
 
            if (!_opts.is_qin_specified())
                _q = _opts.is_force_specified()
                        ? _fg->randomize_q(_rnd)
                        : _rnd.randomize_q(n ,k);
 
            if (_opts.is_fin_force_specified())
                _f = _rnd.randomize_f(
                    k,
                    _g->create_mu(_opts.get_f_epsilon()),
                    *_fif);
            else if (!_opts.is_fin_specified())
                _f = _rnd.randomize_f(
                    k,
                    _g->create_mu(_opts.get_f_epsilon()));
 
            verification_type::validate_gqf_sizes(*_g, _q, _f);
 
            if (_opts.is_force_specified())
                _fg->validate_q(_q);
        }

Here is the call graph for this function:

Member Function Documentation

create_c()

template<typename TValue >

static matrix_type jade::basic_settings< TValue >::create_c ( const matrix_type &  rf )

inlinestatic

Creates the covariance matrix.

Returns

The covariance matrix.

Parameters

rf	The [RK x 1] rooted F matrix.

Definition at line 162 of file nemeco/jade.settings.hpp.

        {
            const auto RK = rf.get_height();
            const auto J  = rf.get_width();
 
            assert(J > 1);
 
            static const auto n1    = value_type(1.0);
            static const auto n0_25 = value_type(0.25);
            const auto        nj    = static_cast<value_type>(J);
            const auto        nj1   = static_cast<value_type>(J - 1);
            const auto        s     = n1 / nj1 / n0_25;
 
            //
            // Create a vector of average row values for the RF matrix.
            //
            matrix_type rf_avg (RK, 1);
            for (size_t rk = 0; rk < RK; rk++)
                rf_avg[rk] = rf.get_row_sum(rk) / nj;
 
            //
            // The covariance matrix is [K-1 x K-1].
            //
            matrix_type c (RK, RK);
 
            //
            // Calculate the lower triangle of sample covariance of the RF
            // matrix and divide it by the mux.
            //
            for (size_t j = 0; j < J; j++)
            {
                for (size_t row = 0; row < RK; row++)
                {
                    const auto s_row = s * (rf(row, j) - rf_avg[row]);
                    for (size_t col = 0; col <= row; col++)
                        c(row, col) += s_row * (rf(col, j) - rf_avg[col]);
                }
            }
 
            //
            // Copy the lower triangle to the upper triangle and return the
            // covariance matrix.
            //
            c.copy_lower_to_upper();
            return c;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

create_rf()

template<typename TValue >

static matrix_type jade::basic_settings< TValue >::create_rf ( const matrix_type &  f )

inlinestatic

Creates the rooted F matrix.

Returns

The rooted F matrix.

Parameters

f	The F matrix for major alleles.

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

        {
            const auto K = f.get_height();
            const auto J = f.get_width();
 
            assert(K > 1);
 
            const auto RK = K - 1;
 
            matrix_type rf (RK, J);
 
            for (size_t rk = 0; rk < RK; rk++)
                for (size_t j = 0; j < J; j++)
                    rf(rk, j) = f(rk + 1, j) - f(0, j);
 
            return rf;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

get_agi()

template<typename TValue >

const agi_reader_type& jade::basic_settings< TValue >::get_agi ( ) const

inline

Returns

The admixture graph input reader.

Definition at line 120 of file nemeco/jade.settings.hpp.

        {
            assert(nullptr != _agi.get());
            return *_agi;
        }

get_c()

template<typename TValue >

const matrix_type& jade::basic_settings< TValue >::get_c ( ) const

inline

Returns

The C matrix.

Definition at line 129 of file nemeco/jade.settings.hpp.

        {
            return _c;
        }

get_f() [1/4]

template<typename TValue >

matrix_type& jade::basic_settings< TValue >::get_f ( )

inline

Returns

The F matrix.

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

        {
            return _f;
        }

get_f() [2/4]

template<typename TValue >

matrix_type& jade::basic_settings< TValue >::get_f ( )

inline

Returns

The F matrix.

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

        {
            return _f;
        }

get_f() [3/4]

template<typename TValue >

const matrix_type& jade::basic_settings< TValue >::get_f ( ) const

inline

Returns

The F matrix.

Definition at line 133 of file cpax/jade.settings.hpp.

        {
            return _f;
        }

get_f() [4/4]

template<typename TValue >

const matrix_type& jade::basic_settings< TValue >::get_f ( ) const

inline

Returns

The F matrix.

Definition at line 133 of file qpas/jade.settings.hpp.

        {
            return _f;
        }

get_fg() [1/2]

template<typename TValue >

const forced_grouping_type* jade::basic_settings< TValue >::get_fg ( ) const

inline

Returns

A pointer to the forced grouping file or nullptr if the information is not available.

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

        {
            return _fg.get();
        }

Here is the caller graph for this function:

get_fg() [2/2]

template<typename TValue >

const forced_grouping_type* jade::basic_settings< TValue >::get_fg ( ) const

inline

Returns

A pointer to the forced grouping file or nullptr if the information is not available.

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

        {
            return _fg.get();
        }

get_fif() [1/2]

template<typename TValue >

const matrix_type* jade::basic_settings< TValue >::get_fif ( ) const

inline

Returns

The Fin-force matrix.

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

        {
            return _fif.get();
        }

Here is the caller graph for this function:

get_fif() [2/2]

template<typename TValue >

const matrix_type* jade::basic_settings< TValue >::get_fif ( ) const

inline

Returns

The Fin-force matrix.

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

        {
            return _fif.get();
        }

get_g() [1/2]

template<typename TValue >

const genotype_matrix_type& jade::basic_settings< TValue >::get_g ( ) const

inline

Returns

The genotype matrix.

Definition at line 166 of file cpax/jade.settings.hpp.

        {
            return *_g;
        }

Here is the caller graph for this function:

get_g() [2/2]

template<typename TValue >

const genotype_matrix_type& jade::basic_settings< TValue >::get_g ( ) const

inline

Returns

The genotype matrix.

Definition at line 166 of file qpas/jade.settings.hpp.

        {
            return *_g;
        }

get_mu()

template<typename TValue >

const matrix_type& jade::basic_settings< TValue >::get_mu ( ) const

inline

Returns

The mu vector.

Definition at line 137 of file nemeco/jade.settings.hpp.

        {
            return _mu;
        }

get_options() [1/3]

template<typename TValue >

const options_type& jade::basic_settings< TValue >::get_options ( ) const

inline

Returns

The options.

Definition at line 174 of file cpax/jade.settings.hpp.

        {
            return _opts;
        }

Here is the caller graph for this function:

get_options() [2/3]

template<typename TValue >

const options_type& jade::basic_settings< TValue >::get_options ( ) const

inline

Returns

The options.

Definition at line 145 of file nemeco/jade.settings.hpp.

        {
            return _opts;
        }

get_options() [3/3]

template<typename TValue >

const options_type& jade::basic_settings< TValue >::get_options ( ) const

inline

Returns

The options.

Definition at line 174 of file qpas/jade.settings.hpp.

        {
            return _opts;
        }

get_q() [1/4]

template<typename TValue >

matrix_type& jade::basic_settings< TValue >::get_q ( )

inline

Returns

The Q matrix.

Definition at line 190 of file cpax/jade.settings.hpp.

        {
            return _q;
        }

get_q() [2/4]

template<typename TValue >

matrix_type& jade::basic_settings< TValue >::get_q ( )

inline

Returns

The Q matrix.

Definition at line 190 of file qpas/jade.settings.hpp.

        {
            return _q;
        }

get_q() [3/4]

template<typename TValue >

const matrix_type& jade::basic_settings< TValue >::get_q ( ) const

inline

Returns

The Q matrix.

Definition at line 182 of file cpax/jade.settings.hpp.

        {
            return _q;
        }

get_q() [4/4]

template<typename TValue >

const matrix_type& jade::basic_settings< TValue >::get_q ( ) const

inline

Returns

The Q matrix.

Definition at line 182 of file qpas/jade.settings.hpp.

        {
            return _q;
        }

get_randomizer() [1/2]

template<typename TValue >

const randomizer_type& jade::basic_settings< TValue >::get_randomizer ( ) const

inline

Returns

The randomizer.

Definition at line 198 of file cpax/jade.settings.hpp.

        {
            return _rnd;
        }

get_randomizer() [2/2]

template<typename TValue >

const randomizer_type& jade::basic_settings< TValue >::get_randomizer ( ) const

inline

Returns

The randomizer.

Definition at line 198 of file qpas/jade.settings.hpp.

        {
            return _rnd;
        }

get_rf()

template<typename TValue >

const matrix_type& jade::basic_settings< TValue >::get_rf ( ) const

inline

Returns

The rooted F matrix.

Definition at line 153 of file nemeco/jade.settings.hpp.

        {
            return _rf;
        }

---

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

• cpax/jade.settings.hpp