gstlrn::TurboOptimizer Class Reference

Turbo Optimizer for a specific 2-D environment,. More...

#include <TurboOptimizer.hpp>

Detailed Description

Turbo Optimizer for a specific 2-D environment,.

with an isotropic Matérn Model

Public Member Functions
	TurboOptimizer (Id nx=2, Id ny=2, double dx=1., double dy=1., double x0=0., double y0=0., double scale=1., double sill=1., Id param=1, Id flagOne=1)
	TurboOptimizer (const TurboOptimizer &tbo)
TurboOptimizer &	operator= (const TurboOptimizer &tbo)
virtual	~TurboOptimizer ()
void	setGrid (Id nx=2, Id ny=2, double dx=1., double dy=1., double x0=0., double y0=0.)
void	setModelByRange (double range=1., double sill=1., Id param=1)
void	setModelByScale (double scale=1., double sill=1., Id param=1)
void	setEnviron (Id flagOne=1)
void	run (bool verbose=false)
	getBlin () const
	getTildeC () const
	getLambda () const
TripletND	getS () const
TripletND	getQ () const
TripletND	interpolate (const 1 &x, const 1 &y) const
	interpolate_rows (const 1 &x, const 1 &y) const
	interpolate_cols (const 1 &x, const 1 &y) const
	interpolate_values (const 1 &x, const 1 &y) const
	getQ_rows () const
	getQ_cols () const
	getQ_values () const
void	printClass () const
void	printMeshes () const
void	printS (Id nper_batch=5, Id row_begin=0, Id row_end=0, Id col_begin=0, Id col_end=0) const
void	printQ (Id nper_batch=5, Id row_begin=0, Id row_end=0, Id col_begin=0, Id col_end=0) const
Id	getHalf () const
Id	getCenter () const
Id	getNxred () const
Id	getPoncif () const
const &	getTildeCT () const
const &	getLambdaT () const
const &	getQT () const
const &	getST () const

Constructor & Destructor Documentation

TurboOptimizer() [1/2]

gstlrn::TurboOptimizer::TurboOptimizer	(	Id	nx = 2,
		Id	ny = 2,
		double	dx = 1.,
		double	dy = 1.,
		double	x0 = 0.,
		double	y0 = 0.,
		double	scale = 1.,
		double	sill = 1.,
		Id	param = 1,
		Id	flagOne = 1
	)

TurboOptimizer() [2/2]

gstlrn::TurboOptimizer::TurboOptimizer

(

const TurboOptimizer &

tbo

)

~TurboOptimizer()

gstlrn::TurboOptimizer::~TurboOptimizer ( )

virtual

Member Function Documentation

getBlin()

gstlrn::TurboOptimizer::getBlin

(

)

const

Allows retrieving the vector Blin

Returns

The Blin vector

getCenter()

Id gstlrn::TurboOptimizer::getCenter ( ) const

inline

getHalf()

Id gstlrn::TurboOptimizer::getHalf ( ) const

inline

getLambda()

gstlrn::TurboOptimizer::getLambda

(

)

const

Allows retrieving the vector Lambda

Returns

The Lambda vector

getLambdaT()

const & gstlrn::TurboOptimizer::getLambdaT ( ) const

inline

getNxred()

Id gstlrn::TurboOptimizer::getNxred ( ) const

inline

getPoncif()

Id gstlrn::TurboOptimizer::getPoncif ( ) const

inline

getQ()

TripletND gstlrn::TurboOptimizer::getQ

(

)

const

Allows retrieving the Q sparse matrix

Returns

The returned matrix stored as Triplets

getQ_cols()

gstlrn::TurboOptimizer::getQ_cols ( ) const

inline

getQ_rows()

gstlrn::TurboOptimizer::getQ_rows ( ) const

inline

getQ_values()

gstlrn::TurboOptimizer::getQ_values ( ) const

inline

getQT()

const & gstlrn::TurboOptimizer::getQT ( ) const

inline

getS()

TripletND gstlrn::TurboOptimizer::getS

(

)

const

Allows retrieving the S sparse matrix

Returns

The returned matrix stored as TripletNDs

getST()

const & gstlrn::TurboOptimizer::getST ( ) const

inline

getTildeC()

gstlrn::TurboOptimizer::getTildeC

(

)

const

Allows retrieving the vector TildeC

Returns

The TildeC vector

getTildeCT()

const & gstlrn::TurboOptimizer::getTildeCT ( ) const

inline

interpolate()

TripletND gstlrn::TurboOptimizer::interpolate	(	const 1 &	x,
		const 1 &	y
	)		const

Returns the weights for interpolating points on the meshing

Parameters

x	Vector of X-coordinates for the target points
y	Vector of Y-coordinates for the target points

Returns

The triplet structure giving the interpolation weights

Note

: The triplets contain:

: - rows: the index of the target point

: - cols: the index of the node of the grid

: - values: the corresponding weight

interpolate_cols()

gstlrn::TurboOptimizer::interpolate_cols ( const 1 &  x, const 1 &  y  ) const

inline

interpolate_rows()

gstlrn::TurboOptimizer::interpolate_rows ( const 1 &  x, const 1 &  y  ) const

inline

interpolate_values()

gstlrn::TurboOptimizer::interpolate_values ( const 1 &  x, const 1 &  y  ) const

inline

operator=()

TurboOptimizer & gstlrn::TurboOptimizer::operator=

(

const TurboOptimizer &

tbo

)

printClass()

void gstlrn::TurboOptimizer::printClass

(

)

const

Display the parameters of the Method (Grid and Model parameters)

printMeshes()

void gstlrn::TurboOptimizer::printMeshes

(

)

const

Print the elements of the Internal Meshing

printQ()

void gstlrn::TurboOptimizer::printQ	(	Id	nper_batch = 5,
		Id	row_begin = 0,
		Id	row_end = 0,
		Id	col_begin = 0,
		Id	col_end = 0
	)		const

printS()

void gstlrn::TurboOptimizer::printS	(	Id	nper_batch = 5,
		Id	row_begin = 0,
		Id	row_end = 0,
		Id	col_begin = 0,
		Id	col_end = 0
	)		const

run()

void gstlrn::TurboOptimizer::run

(

bool

verbose = false

)

This function is compulsory as it performs the calculations and allows retrieval of the matrices

Parameters

verbose

Verbose flag

setEnviron()

void gstlrn::TurboOptimizer::setEnviron

(

Id

flagOne = 1

)

Generic method to set all the remaining terms of the class

Parameters

flagOne

Starting value for numbering of rows and columns in TripletND

setGrid()

void gstlrn::TurboOptimizer::setGrid	(	Id	nx = 2,
		Id	ny = 2,
		double	dx = 1.,
		double	dy = 1.,
		double	x0 = 0.,
		double	y0 = 0.
	)

Definition of the 2-D non rotated Grid

Parameters

nx	Number of nodes along X
ny	Number of nodes along Y
dx	Mesh of the grid along X
dy	Mesh of the grid along Y
x0	Origin of the grid along X
y0	Origin of the grid along Y

setModelByRange()

void gstlrn::TurboOptimizer::setModelByRange	(	double	range = 1.,
		double	sill = 1.,
		Id	param = 1
	)

Definition of the Model (single isotropic Matérn structure) by range

Parameters

range	Range of the structure
sill	Sill of the structure
param	Matérn parameter (third parameter)

setModelByScale()

void gstlrn::TurboOptimizer::setModelByScale	(	double	scale = 1.,
		double	sill = 1.,
		Id	param = 1
	)

Definition of the Model (single isotropic Matérn structure) by scale

Parameters

scale	Scale of the structure
sill	Sill of the structure
param	Matérn parameter (third parameter)

---

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

• include/LinearOp/TurboOptimizer.hpp
• src/LinearOp/TurboOptimizer.cpp