A class providing adaptive distribution of the transverse momentum points. More...

Inheritance diagram for adaptiveQ:

Public Member Functions
function	adaptiveQ (Opt, interpq, varargin)
	Constructor of the class. More...

function	Clear (MemberName)
	Clears the value of an attribute in the interface. More...

function	display (message, nosilent)
	Displays output messages on the screen. More...

function	getOpt ()
	Retrives the structure containing the calculation parameters. More...

function	initialize (fhandle)
	Initializes y = fhandle( qvec ) for the first iteration. More...

function	Read (MemberName)
	Query for the value of an attribute in the interface. More...

function	runAdaptiveIterations (fhandle)
	Runs the adaptive iterations to obtain the elemets of qvec where the function fhandle changes the most. More...

function	Write (MemberName, input)
	Sets the value of an attribute in the interface. More...

Static Public Member Functions
static function	BadInputType (variable, type)
	Throws a "bad input type" warning, with using the default value. More...

static function	BadInputTypeNoDefault (variable, type)
	Throws a "bad input type" warning without setting it to default. More...

static function	ExceedIteration ()
	Throws an "iteration exceeded" warning. More...

Protected Member Functions
function	defNewq (unaccurateq)
	Defines the new transverse momentums to performs the next iteration. More...

function	getUnaccurateq ()
	Determine the transverse momentum points at which the interpolated function fhandle is unaccurate. More...

function	joinq (newq, newy)
	Joins the new transverse moment points with the old ones. More...

Protected Attributes
Property	interp_method
	Method of the interpolation (see http://www.mathworks.com/help/matlab/ref/interp1.html ) More...

Property	interpq
	The list of transverse momentums where the function fhandle is desired to be calculated. More...

Property	interpy
	The interpolated values of fhandle over the elements of interpq. More...

Property	maxiter
	Maximum of the iterations. More...

Property	Opt
	An instance of structure Opt. More...

Property	outFileName
	The filename to export the calculated data. More...

Property	qvec
	The dynamically created vector of the transverse momentums. More...

Property	resume
	Logical value. If true, the iteration cintinues with the loaded data, or false (default) otherwise. More...

Property	start_qnum
	The number of elements in qvec in the first iteration. More...

Property	y
	The function values of fhandle calculated over the elements of qvec. More...

Private Member Functions
function	InputParsing (varargin)
	Parses the optional parameters for the class constructor. More...

Detailed Description

A class providing adaptive distribution of the transverse momentum points.

A minimal list of transverse momentums (qvec) and the corresponding function values (y) of fhandle are dynamicaly created in order to obtain the values of fhandle over the elements of interpq via interpolation. (Typically qvec contains significantly less elements than interpq.)

Available

EQuUs v4.6 or later

Definition at line 27 of file adaptiveQ.m.

Constructor & Destructor Documentation

◆ adaptiveQ()

function adaptiveQ::adaptiveQ	(	Opt	,
		interpq	,
		varargin
	)

Constructor of the class.

Parameters

Opt	An instance of the structure Opt.
interpq	An array of transverse momentum points at which fhandle is calculated via interpolation.
varargin	Cell array of optional parameters. For details see @InputParsing.

Returns: An instance of the class

Member Function Documentation

◆ BadInputType()

static function Messages::BadInputType	(	variable	,
		type
	)

staticinherited

Throws a "bad input type" warning, with using the default value.

Parameters

variable	A string conatining the name of the variable.
type	A string describing the desired type.

◆ BadInputTypeNoDefault()

static function Messages::BadInputTypeNoDefault	(	variable	,
		type
	)

staticinherited

Throws a "bad input type" warning without setting it to default.

Parameters

variable	A string conatining the name of the variable.
type	A string describing the desired type.

◆ Clear()

function adaptiveQ::Clear ( MemberName )

Clears the value of an attribute in the interface.

Parameters

MemberName The name of the attribute to be cleared.

◆ defNewq()

function adaptiveQ::defNewq ( unaccurateq )

protected

Defines the new transverse momentums to performs the next iteration.

Parameters

unaccurateq The list of transverse moments at which the interpolated function fhandle is unaccurate.

Returns: Returns with the list of new transverse moments at which the function fhandle should be calculated to improve the accuracy of the interpolation.

◆ display()

function Messages::display	(	message	,
		nosilent
	)

inherited

Displays output messages on the screen.

Parameters

message	String containing the message to be displayed
nosilent	Set true to override the silent option given in Opt.Silent.

◆ ExceedIteration()

static function Messages::ExceedIteration ( )

staticinherited

Throws an "iteration exceeded" warning.

◆ getOpt()

function Messages::getOpt ( )

inherited

Retrives the structure containing the calculation parameters.

Returns: Return an instance of structure Opt.

◆ getUnaccurateq()

function adaptiveQ::getUnaccurateq ( )

protected

Determine the transverse momentum points at which the interpolated function fhandle is unaccurate.

Returns: Returns with the list of unaccurate transverse moments at which the interpolated function fhandle is unaccurate.

◆ initialize()

function adaptiveQ::initialize ( fhandle )

Initializes y = fhandle( qvec ) for the first iteration.

Parameters

fhandle The function handle to be calculated over the transverse momentum points: y = fhandle( qvec ), where y is an MxN matrix, and qvec is a vector of transverse momentums containing of M elements.

◆ InputParsing()

function adaptiveQ::InputParsing ( varargin )

private

Parses the optional parameters for the class constructor.

Parameters

varargin	Cell array of optional parameters (https://www.mathworks.com/help/matlab/ref/varargin.html):
'resume'	Logical value. If true, the iteration continues with the loaded data, or false (default) otherwise.
'outFileName'	The filename to save the calculated data. If it is empty (default) no data are exported.
'interp_method'	The interpolation method to be used to calculate interpy. The default method is spline.

◆ joinq()

function adaptiveQ::joinq	(	newq	,
		newy
	)

protected

Joins the new transverse moment points with the old ones.

Parameters

newq	The new transverse momentum points.
newy	The values of the function fhandle calculated at points newq.

◆ Read()

function adaptiveQ::Read ( MemberName )

Query for the value of an attribute in the interface.

Parameters

MemberName The name of the attribute to be set.

Returns: Returns with the value of the attribute.

◆ runAdaptiveIterations()

function adaptiveQ::runAdaptiveIterations ( fhandle )

Runs the adaptive iterations to obtain the elemets of qvec where the function fhandle changes the most.

Parameters

fhandle The function handle to be calculated over the transverse momentum points: y = fhandle( qvec ), where y is an MxN matrix, and qvec is a vector of transverse momentums containing of M elements.

◆ Write()

function adaptiveQ::Write	(	MemberName	,
		input
	)

Sets the value of an attribute in the interface.

Parameters

MemberName	The name of the attribute to be set.
input	The value to be set.

Member Data Documentation

◆ interp_method

Property adaptiveQ::interp_method

protected

Method of the interpolation (see http://www.mathworks.com/help/matlab/ref/interp1.html )

Definition at line 58 of file adaptiveQ.m.

◆ interpq

Property adaptiveQ::interpq

protected

The list of transverse momentums where the function fhandle is desired to be calculated.

Definition at line 37 of file adaptiveQ.m.

◆ interpy

Property adaptiveQ::interpy

protected

The interpolated values of fhandle over the elements of interpq.

Definition at line 40 of file adaptiveQ.m.

◆ maxiter

Property adaptiveQ::maxiter

protected

Maximum of the iterations.

Definition at line 49 of file adaptiveQ.m.

◆ Opt

Property Messages::Opt

protectedinherited

An instance of structure Opt.

Definition at line 31 of file Messages.m.

◆ outFileName

Property adaptiveQ::outFileName

protected

The filename to export the calculated data.

Definition at line 55 of file adaptiveQ.m.

◆ qvec

Property adaptiveQ::qvec

protected

The dynamically created vector of the transverse momentums.

Definition at line 43 of file adaptiveQ.m.

◆ resume

Property adaptiveQ::resume

protected

Logical value. If true, the iteration cintinues with the loaded data, or false (default) otherwise.

Definition at line 52 of file adaptiveQ.m.

◆ start_qnum

Property adaptiveQ::start_qnum

protected

The number of elements in qvec in the first iteration.

Definition at line 34 of file adaptiveQ.m.

◆ y

Property adaptiveQ::y

protected

The function values of fhandle calculated over the elements of qvec.

Definition at line 46 of file adaptiveQ.m.

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

adaptiveQ.m

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Available

Constructor & Destructor Documentation

◆ adaptiveQ()

Member Function Documentation

◆ BadInputType()

◆ BadInputTypeNoDefault()

◆ Clear()

◆ defNewq()

◆ display()

◆ ExceedIteration()

◆ getOpt()

◆ getUnaccurateq()

◆ initialize()

◆ InputParsing()

◆ joinq()

◆ Read()

◆ runAdaptiveIterations()

◆ Write()

Member Data Documentation

◆ interp_method

◆ interpq

◆ interpy

◆ maxiter

◆ Opt

◆ outFileName

◆ qvec

◆ resume

◆ start_qnum

◆ y