Workspace functions for straightforward operations on variables of basic types. More...

#include <cmath>
#include "arts.h"
#include "array.h"
#include "matpackI.h"
#include "matpackII.h"
#include "matpackIII.h"
#include "matpackIV.h"
#include "matpackV.h"
#include "matpackVI.h"
#include "matpackVII.h"
#include "mystring.h"
#include "exceptions.h"
#include "make_array.h"
#include "math_funcs.h"
#include "messages.h"
#include "logic.h"
#include "sorting.h"

Functions
void	ArrayOfIndexSet (ArrayOfIndex &aoi, const ArrayOfIndex &values, const Verbosity &)
	WORKSPACE METHOD: ArrayOfIndexSet. More...

void	ArrayOfIndexSetConstant (ArrayOfIndex &aoi, const Index &nelem, const Index &value, const Verbosity &)
	WORKSPACE METHOD: ArrayOfIndexSetConstant. More...

void	ArrayOfStringSet (ArrayOfString &sa, const ArrayOfString &sa2, const Verbosity &)
	WORKSPACE METHOD: ArrayOfStringSet. More...

void	FlagOff (Index &x, const Verbosity &)
	WORKSPACE METHOD: FlagOff. More...

void	FlagOn (Index &x, const Verbosity &)
	WORKSPACE METHOD: FlagOn. More...

void	IndexSet (Index &x, const Index &value, const Verbosity &)
	WORKSPACE METHOD: IndexSet. More...

void	IndexStep (Index &xout, const Index &xin, const Verbosity &)
	WORKSPACE METHOD: IndexStep. More...

void	MatrixMatrixMultiply (Matrix &Y, const Matrix &M, const Matrix &X, const Verbosity &)
	WORKSPACE METHOD: MatrixMatrixMultiply. More...

void	Matrix1ColFromVector (Matrix &m, const Vector &v, const Verbosity &)
	WORKSPACE METHOD: Matrix1ColFromVector. More...

void	Matrix2ColFromVectors (Matrix &m, const Vector &v1, const Vector &v2, const Verbosity &)
	WORKSPACE METHOD: Matrix2ColFromVectors. More...

void	Matrix3ColFromVectors (Matrix &m, const Vector &v1, const Vector &v2, const Vector &v3, const Verbosity &)
	WORKSPACE METHOD: Matrix3ColFromVectors. More...

void	MatrixCompare (const Matrix &matrix1, const Matrix &matrix2, const Numeric &maxabsdiff, const Verbosity &verbosity)
	WORKSPACE METHOD: MatrixCompare. More...

void	Matrix1RowFromVector (Matrix &m, const Vector &v, const Verbosity &)
	WORKSPACE METHOD: Matrix1RowFromVector. More...

void	Matrix2RowFromVectors (Matrix &m, const Vector &v1, const Vector &v2, const Verbosity &)
	WORKSPACE METHOD: Matrix2RowFromVectors. More...

void	Matrix3RowFromVectors (Matrix &m, const Vector &v1, const Vector &v2, const Vector &v3, const Verbosity &)
	WORKSPACE METHOD: Matrix3RowFromVectors. More...

void	MatrixScale (Matrix &out, const Matrix &in, const Numeric &value, const Verbosity &)
	WORKSPACE METHOD: MatrixScale. More...

void	MatrixSet (Matrix &x, const Matrix &values, const Verbosity &)
	WORKSPACE METHOD: MatrixSet. More...

void	MatrixSetConstant (Matrix &x, const Index &nrows, const Index &ncols, const Numeric &value, const Verbosity &)
	WORKSPACE METHOD: MatrixSetConstant. More...

void	NumericAdd (Numeric &out, const Numeric &in, const Numeric &value, const Verbosity &)
	WORKSPACE METHOD: NumericAdd. More...

void	NumericScale (Numeric &out, const Numeric &in, const Numeric &value, const Verbosity &)
	WORKSPACE METHOD: NumericScale. More...

void	NumericSet (Numeric &x, const Numeric &value, const Verbosity &)
	WORKSPACE METHOD: NumericSet. More...

void	SparseSparseMultiply (Sparse &Y, const Sparse &M, const Sparse &X, const Verbosity &)
	WORKSPACE METHOD: SparseSparseMultiply. More...

void	StringSet (String &s, const String &s2, const Verbosity &)
	WORKSPACE METHOD: StringSet. More...

void	Tensor3AddScalar (Tensor3 &out, const Tensor3 &in, const Numeric &value, const Verbosity &)
	WORKSPACE METHOD: Tensor3AddScalar. More...

void	Tensor3Scale (Tensor3 &out, const Tensor3 &in, const Numeric &value, const Verbosity &)
	WORKSPACE METHOD: Tensor3Scale. More...

void	Tensor3SetConstant (Tensor3 &x, const Index &npages, const Index &nrows, const Index &ncols, const Numeric &value, const Verbosity &verbosity)
	WORKSPACE METHOD: Tensor3SetConstant. More...

void	Tensor4Scale (Tensor4 &out, const Tensor4 &in, const Numeric &value, const Verbosity &)
	WORKSPACE METHOD: Tensor4Scale. More...

void	Tensor4SetConstant (Tensor4 &x, const Index &nbooks, const Index &npages, const Index &nrows, const Index &ncols, const Numeric &value, const Verbosity &verbosity)
	WORKSPACE METHOD: Tensor4SetConstant. More...

void	Tensor5Scale (Tensor5 &out, const Tensor5 &in, const Numeric &value, const Verbosity &)
	WORKSPACE METHOD: Tensor5Scale. More...

void	Tensor5SetConstant (Tensor5 &x, const Index &nshelves, const Index &nbooks, const Index &npages, const Index &nrows, const Index &ncols, const Numeric &value, const Verbosity &verbosity)
	WORKSPACE METHOD: Tensor5SetConstant. More...

void	Tensor6Scale (Tensor6 &out, const Tensor6 &in, const Numeric &value, const Verbosity &)
	WORKSPACE METHOD: Tensor6Scale. More...

void	Tensor6SetConstant (Tensor6 &x, const Index &nvitrines, const Index &nshelves, const Index &nbooks, const Index &npages, const Index &nrows, const Index &ncols, const Numeric &value, const Verbosity &verbosity)
	WORKSPACE METHOD: Tensor6SetConstant. More...

void	Tensor7Scale (Tensor7 &out, const Tensor7 &in, const Numeric &value, const Verbosity &)
	WORKSPACE METHOD: Tensor7Scale. More...

void	Tensor7SetConstant (Tensor7 &x, const Index &nlibraries, const Index &nvitrines, const Index &nshelves, const Index &nbooks, const Index &npages, const Index &nrows, const Index &ncols, const Numeric &value, const Verbosity &verbosity)
	WORKSPACE METHOD: Tensor7SetConstant. More...

void	VectorAddScalar (Vector &out, const Vector &in, const Numeric &value, const Verbosity &)
	WORKSPACE METHOD: VectorAddScalar. More...

void	VectorFlip (Vector &out, const Vector &in, const Verbosity &)
	WORKSPACE METHOD: VectorFlip. More...

void	VectorInsertGridPoints (Vector &og, const Vector &ingrid, const Vector &points, const Verbosity &verbosity)
	WORKSPACE METHOD: VectorInsertGridPoints. More...

void	VectorLinSpace (Vector &x, const Numeric &start, const Numeric &stop, const Numeric &step, const Verbosity &verbosity)
	WORKSPACE METHOD: VectorLinSpace. More...

void	VectorLogSpace (Vector &x, const Numeric &start, const Numeric &stop, const Numeric &step, const Verbosity &verbosity)
	WORKSPACE METHOD: VectorLogSpace. More...

void	VectorMatrixMultiply (Vector &y, const Matrix &M, const Vector &x, const Verbosity &)
	WORKSPACE METHOD: VectorMatrixMultiply. More...

void	VectorNLinSpace (Vector &x, const Index &n, const Numeric &start, const Numeric &stop, const Verbosity &verbosity)
	WORKSPACE METHOD: VectorNLinSpace. More...

void	VectorNLogSpace (Vector &x, const Index &n, const Numeric &start, const Numeric &stop, const Verbosity &verbosity)
	WORKSPACE METHOD: VectorNLogSpace. More...

void	VectorScale (Vector &out, const Vector &in, const Numeric &value, const Verbosity &)
	WORKSPACE METHOD: VectorScale. More...

void	VectorSetConstant (Vector &x, const Index &n, const Numeric &value, const Verbosity &verbosity)
	WORKSPACE METHOD: VectorSetConstant. More...

void	VectorSet (Vector &x, const Vector &values, const Verbosity &)
	WORKSPACE METHOD: VectorSet. More...

Detailed Description

Workspace functions for straightforward operations on variables of basic types.

Author: Patrick Eriksson Patri.nosp@m.ck.E.nosp@m.rikss.nosp@m.on@r.nosp@m.ss.ch.nosp@m.alme.nosp@m.rs.se

Date: 2002-05-08

This file includes workspace functions for variables of basic types, such as Matrix and ArrayOfIndex. The functions are mainly of two types:

Initiation of variables by keyword arguments, such as StringSet.
Basic math, such as MatrixVectorMultiply.

These functions are listed in the doxygen documentation as entries of the file auto_md.h.

Definition in file m_basic_types.cc.

Function Documentation

◆ ArrayOfIndexSet()

void ArrayOfIndexSet	(	ArrayOfIndex &	ai,
		const ArrayOfIndex &	values,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: ArrayOfIndexSet.

Creates an ArrayOfIndex from the given list of numbers.

Author: Oliver Lemke

Parameters

[out]	ai	Generic output
[in]	values	Generic Input

Definition at line 74 of file m_basic_types.cc.

Referenced by ArrayOfIndexSet_g().

◆ ArrayOfIndexSetConstant()

void ArrayOfIndexSetConstant	(	ArrayOfIndex &	ai,
		const Index &	nelem,
		const Index &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: ArrayOfIndexSetConstant.

Creates an ArrayOfIndex of length nelem, with all values identical.

Author: Patrick Eriksson

Parameters

[out]	ai	Generic output
[in]	nelem	WS Input
[in]	value	Generic Input

Definition at line 83 of file m_basic_types.cc.

Referenced by ArrayOfIndexSetConstant_g().

◆ ArrayOfStringSet()

void ArrayOfStringSet	(	ArrayOfString &	as,
		const ArrayOfString &	text,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: ArrayOfStringSet.

Sets a String array according the given text. The format is text = ["String1","String2",...]

Author: Oliver Lemke

Parameters

[out]	as	Generic output
[in]	text	Generic Input

Definition at line 95 of file m_basic_types.cc.

References Array< base >::nelem().

Referenced by ArrayOfStringSet_g().

◆ FlagOff()

void FlagOff	(	Index &	i,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: FlagOff.

Sets an index variable that acts as an on/off flag to 0.

Author: Patrick Eriksson

Parameters

[out] i Generic output

Definition at line 105 of file m_basic_types.cc.

Referenced by FlagOff_g().

◆ FlagOn()

void FlagOn	(	Index &	i,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: FlagOn.

Sets an index variable that acts as an on/off flag to 1.

Author: Patrick Eriksson

Parameters

[out] i Generic output

Definition at line 112 of file m_basic_types.cc.

Referenced by FlagOn_g().

◆ IndexSet()

void IndexSet	(	Index &	i,
		const Index &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: IndexSet.

Sets an index workspace variable to the given value.

Author: Patrick Eriksson

Parameters

[out]	i	Generic output
[in]	value	Generic Input

Definition at line 119 of file m_basic_types.cc.

Referenced by IndexSet_g().

◆ IndexStep()

void IndexStep	(	Index &	i2,
		const Index &	gin1,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: IndexStep.

Performs i2 = i1 + 1

Input and output can be same variable.

Author: Patrick Eriksson

Parameters

[out]	i2	Generic output
[in]	gin1	Generic Input

Definition at line 127 of file m_basic_types.cc.

Referenced by IndexStep_g().

◆ Matrix1ColFromVector()

void Matrix1ColFromVector	(	Matrix &	m,
		const Vector &	v,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Matrix1ColFromVector.

Forms a matrix containing one column from a vector.

Author: Mattias Ekstrom

Parameters

[out]	m	Generic output
[in]	v	Generic Input

Definition at line 166 of file m_basic_types.cc.

References joker, ConstVectorView::nelem(), and Matrix::resize().

Referenced by Matrix1ColFromVector_g().

◆ Matrix1RowFromVector()

void Matrix1RowFromVector	(	Matrix &	m,
		const Vector &	v,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Matrix1RowFromVector.

Forms a matrix containing one row from a vector.

Author: Mattias Ekstrom

Parameters

[out]	m	Generic output
[in]	v	Generic Input

Definition at line 259 of file m_basic_types.cc.

References joker, ConstVectorView::nelem(), and Matrix::resize().

Referenced by Matrix1RowFromVector_g().

◆ Matrix2ColFromVectors()

void Matrix2ColFromVectors	(	Matrix &	m,
		const Vector &	v1,
		const Vector &	v2,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Matrix2ColFromVectors.

Forms a matrix containing two columns from two vectors.

The vectors are included as columns in the matrix in the same order as they are given.

Author: Mattias Ekstrom

Parameters

[out]	m	Generic output
[in]	v1	Generic Input
[in]	v2	Generic Input

Definition at line 180 of file m_basic_types.cc.

References joker, ConstVectorView::nelem(), and Matrix::resize().

Referenced by Matrix2ColFromVectors_g().

◆ Matrix2RowFromVectors()

void Matrix2RowFromVectors	(	Matrix &	m,
		const Vector &	v1,
		const Vector &	v2,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Matrix2RowFromVectors.

Forms a matrix containing two rows from two vectors.

The vectors are included as rows in the matrix in the same order as they are given.

Author: Mattias Ekstrom

Parameters

[out]	m	Generic output
[in]	v1	Generic Input
[in]	v2	Generic Input

Definition at line 273 of file m_basic_types.cc.

References joker, ConstVectorView::nelem(), and Matrix::resize().

Referenced by Matrix2RowFromVectors_g().

◆ Matrix3ColFromVectors()

void Matrix3ColFromVectors	(	Matrix &	m,
		const Vector &	v1,
		const Vector &	v2,
		const Vector &	v3,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Matrix3ColFromVectors.

Forms a matrix containing three columns from three vectors.

The vectors are included as columns in the matrix in the same order as they are given.

Author: Mattias Ekstrom

Parameters

[out]	m	Generic output
[in]	v1	Generic Input
[in]	v2	Generic Input
[in]	v3	Generic Input

Definition at line 200 of file m_basic_types.cc.

References joker, ConstVectorView::nelem(), and Matrix::resize().

Referenced by Matrix3ColFromVectors_g().

◆ Matrix3RowFromVectors()

void Matrix3RowFromVectors	(	Matrix &	m,
		const Vector &	v1,
		const Vector &	v2,
		const Vector &	v3,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Matrix3RowFromVectors.

Forms a matrix containing three rows from three vectors.

The vectors are included as rows in the matrix in the same order as they are given.

Author: Mattias Ekstrom

Parameters

[out]	m	Generic output
[in]	v1	Generic Input
[in]	v2	Generic Input
[in]	v3	Generic Input

Definition at line 293 of file m_basic_types.cc.

References joker, ConstVectorView::nelem(), and Matrix::resize().

Referenced by Matrix3RowFromVectors_g().

◆ MatrixCompare()

void MatrixCompare	(	const Matrix &	matrix1,
		const Matrix &	matrix2,
		const Numeric &	maxabsdiff,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: MatrixCompare.

Checks the deviation between two matrices.

The method was implemented having jacobian matrices in mind, but can be applied on any matrices.

It is checked if the maximum absolute difference is below the given limit.

Author: Patrick Eriksson

Parameters

[in]	matrix1	Generic Input
[in]	matrix2	Generic Input
[in]	maxabsdiff	Generic Input (Default: "0.01")

Definition at line 221 of file m_basic_types.cc.

References CREATE_OUT2, ConstMatrixView::ncols(), and ConstMatrixView::nrows().

Referenced by MatrixCompare_g().

◆ MatrixMatrixMultiply()

void MatrixMatrixMultiply	(	Matrix &	gout1,
		const Matrix &	gin1,
		const Matrix &	gin2,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: MatrixMatrixMultiply.

Multiply a Matrix with another Matrix and store the result in the result Matrix.

This just computes the normal Matrix-Matrix product, Y=M*X. It is ok if Y and X are the same Matrix. This function is handy for multiplying the H Matrix to batch spectra.

Author: Stefan Buehler

Parameters

[out]	gout1	Generic output
[in]	gin1	Generic Input
[in]	gin2	Generic Input

Definition at line 136 of file m_basic_types.cc.

References M, mult(), ConstMatrixView::ncols(), ConstMatrixView::nrows(), and Matrix::resize().

Referenced by MatrixMatrixMultiply_g().

◆ MatrixScale()

void MatrixScale	(	Matrix &	mout,
		const Matrix &	min,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: MatrixScale.

Scales all elements of a matrix with the specified value.

The result can either be stored in the same or another variable.

Author: Patrick Eriksson

Parameters

[out]	mout	Generic output
[in]	min	Generic Input
[in]	value	Generic Input

Definition at line 315 of file m_basic_types.cc.

References ConstMatrixView::ncols(), ConstMatrixView::nrows(), and Matrix::resize().

Referenced by MatrixScale_g().

◆ MatrixSet()

void MatrixSet	(	Matrix &	gout1,
		const Matrix &	values,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: MatrixSet.

Create a Matrix from the given list of numbers.

Usage: MatrixSet(m1, [1, 2, 3; 4, 5, 6])

Author: Oliver Lemke

Parameters

[out]	gout1	Generic output
[in]	values	Generic Input

Definition at line 338 of file m_basic_types.cc.

Referenced by MatrixSet_g().

◆ MatrixSetConstant()

void MatrixSetConstant	(	Matrix &	m,
		const Index &	nrows,
		const Index &	ncols,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: MatrixSetConstant.

Creates a matrix and sets all elements to the specified value.

The size is determined by ncols and nrows.

Author: Patrick Eriksson

Parameters

[out]	m	Generic output
[in]	nrows	WS Input
[in]	ncols	WS Input
[in]	value	Generic Input

Definition at line 347 of file m_basic_types.cc.

References Matrix::resize().

Referenced by MatrixSetConstant_g().

◆ NumericAdd()

void NumericAdd	(	Numeric &	b,
		const Numeric &	a,
		const Numeric &	v,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: NumericAdd.

Adds a numeric and a value (b = a+v).

The result can either be stored in the same or another numeric. (a and b can be the same varible, but not b and v)

Author: Patrick Eriksson

Parameters

[out]	b	Generic output
[in]	a	Generic Input
[in]	v	Generic Input

Definition at line 359 of file m_basic_types.cc.

Referenced by NumericAdd_g().

◆ NumericScale()

void NumericScale	(	Numeric &	b,
		const Numeric &	a,
		const Numeric &	v,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: NumericScale.

Scales/multiplies a numeric with a value (b = a*v).

The result can either be stored in the same or another numeric. (a and b can be the same varible, but not b and v)

Author: Patrick Eriksson

Parameters

[out]	b	Generic output
[in]	a	Generic Input
[in]	v	Generic Input

Definition at line 369 of file m_basic_types.cc.

Referenced by abs_scalar_gasCalcLBL(), and NumericScale_g().

◆ NumericSet()

void NumericSet	(	Numeric &	n,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: NumericSet.

Sets a numeric workspace variable to the given value.

Author: Patrick Eriksson

Parameters

[out]	n	Generic output
[in]	value	Generic Input

Definition at line 379 of file m_basic_types.cc.

Referenced by NumericSet_g().

◆ SparseSparseMultiply()

void SparseSparseMultiply	(	Sparse &	gout,
		const Sparse &	gin1,
		const Sparse &	gin2,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: SparseSparseMultiply.

Multiplies a Sparse with another Sparse, result stored in Sparse.

Makes the calculation gout: = gin1 * gin2

Author: Patrick Eriksson

Parameters

[out]	gout	Generic output
[in]	gin1	Generic Input
[in]	gin2	Generic Input

Definition at line 388 of file m_basic_types.cc.

References M, mult(), Sparse::ncols(), and Sparse::nrows().

Referenced by SparseSparseMultiply_g().

◆ StringSet()

void StringSet	(	String &	s,
		const String &	text,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: StringSet.

Sets a String to the given text string.

Author: Patrick Eriksson

Parameters

[out]	s	Generic output
[in]	text	Generic Input

Definition at line 416 of file m_basic_types.cc.

Referenced by StringSet_g().

◆ Tensor3AddScalar()

void Tensor3AddScalar	(	Tensor3 &	tout,
		const Tensor3 &	tin,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Tensor3AddScalar.

Adds a scalar value to all elements of a tensor3.

The result can either be stored in the same or another variable.

Author: Patrick Eriksson

Parameters

[out]	tout	Generic output
[in]	tin	Generic Input
[in]	value	Generic Input

Definition at line 425 of file m_basic_types.cc.

References ConstTensor3View::ncols(), ConstTensor3View::npages(), ConstTensor3View::nrows(), and Tensor3::resize().

Referenced by Tensor3AddScalar_g().

◆ Tensor3Scale()

void Tensor3Scale	(	Tensor3 &	tout,
		const Tensor3 &	tin,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Tensor3Scale.

Scales all elements of a tensor with the specified value.

The result can either be stored in the same or another variable.

Author: Mattias Ekstrom

Parameters

[out]	tout	Generic output
[in]	tin	Generic Input
[in]	value	Generic Input

Definition at line 445 of file m_basic_types.cc.

References ConstTensor3View::ncols(), ConstTensor3View::npages(), ConstTensor3View::nrows(), and Tensor3::resize().

Referenced by Tensor3Scale_g().

◆ Tensor3SetConstant()

void Tensor3SetConstant	(	Tensor3 &	t,
		const Index &	npages,
		const Index &	nrows,
		const Index &	ncols,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Tensor3SetConstant.

Creates a tensor and sets all elements to the specified value.

The size is determined by ncols, nrows etc.

Author: Claudia Emde

Parameters

[out]	t	Generic output
[in]	npages	WS Input
[in]	nrows	WS Input
[in]	ncols	WS Input
[in]	value	Generic Input

Definition at line 465 of file m_basic_types.cc.

References CREATE_OUT2, CREATE_OUT3, and Tensor3::resize().

Referenced by Tensor3SetConstant_g().

◆ Tensor4Scale()

void Tensor4Scale	(	Tensor4 &	tout,
		const Tensor4 &	tin,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Tensor4Scale.

Scales all elements of a tensor with the specified value.

The result can either be stored in the same or another variable.

Author: Mattias Ekstrom

Parameters

[out]	tout	Generic output
[in]	tin	Generic Input
[in]	value	Generic Input

Definition at line 486 of file m_basic_types.cc.

References ConstTensor4View::nbooks(), ConstTensor4View::ncols(), ConstTensor4View::npages(), ConstTensor4View::nrows(), and Tensor4::resize().

Referenced by Tensor4Scale_g().

◆ Tensor4SetConstant()

void Tensor4SetConstant	(	Tensor4 &	t,
		const Index &	nbooks,
		const Index &	npages,
		const Index &	nrows,
		const Index &	ncols,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Tensor4SetConstant.

Creates a tensor and sets all elements to the specified value.

The size is determined by ncols, nrows etc.

Author: Claudia Emde

Parameters

[out]	t	Generic output
[in]	nbooks	WS Input
[in]	npages	WS Input
[in]	nrows	WS Input
[in]	ncols	WS Input
[in]	value	Generic Input

Definition at line 506 of file m_basic_types.cc.

References CREATE_OUT2, CREATE_OUT3, and Tensor4::resize().

Referenced by Tensor4SetConstant_g().

◆ Tensor5Scale()

void Tensor5Scale	(	Tensor5 &	tout,
		const Tensor5 &	tin,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Tensor5Scale.

Scales all elements of a tensor with the specified value.

The result can either be stored in the same or another variable.

Author: Mattias Ekstrom

Parameters

[out]	tout	Generic output
[in]	tin	Generic Input
[in]	value	Generic Input

Definition at line 529 of file m_basic_types.cc.

References ConstTensor5View::nbooks(), ConstTensor5View::ncols(), ConstTensor5View::npages(), ConstTensor5View::nrows(), ConstTensor5View::nshelves(), and Tensor5::resize().

Referenced by Tensor5Scale_g().

◆ Tensor5SetConstant()

void Tensor5SetConstant	(	Tensor5 &	t,
		const Index &	nshelves,
		const Index &	nbooks,
		const Index &	npages,
		const Index &	nrows,
		const Index &	ncols,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Tensor5SetConstant.

Creates a tensor and sets all elements to the specified value.

The size is determined by ncols, nrows etc.

Author: Claudia Emde

Parameters

[out]	t	Generic output
[in]	nshelves	WS Input
[in]	nbooks	WS Input
[in]	npages	WS Input
[in]	nrows	WS Input
[in]	ncols	WS Input
[in]	value	Generic Input

Definition at line 550 of file m_basic_types.cc.

References CREATE_OUT2, CREATE_OUT3, and Tensor5::resize().

Referenced by Tensor5SetConstant_g().

◆ Tensor6Scale()

void Tensor6Scale	(	Tensor6 &	tout,
		const Tensor6 &	tin,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Tensor6Scale.

Scales all elements of a tensor with the specified value.

The result can either be stored in the same or another variable.

Author: Mattias Ekstrom

Parameters

[out]	tout	Generic output
[in]	tin	Generic Input
[in]	value	Generic Input

Definition at line 575 of file m_basic_types.cc.

References ConstTensor6View::nbooks(), ConstTensor6View::ncols(), ConstTensor6View::npages(), ConstTensor6View::nrows(), ConstTensor6View::nshelves(), ConstTensor6View::nvitrines(), and Tensor6::resize().

Referenced by Tensor6Scale_g().

◆ Tensor6SetConstant()

void Tensor6SetConstant	(	Tensor6 &	t,
		const Index &	nvitrines,
		const Index &	nshelves,
		const Index &	nbooks,
		const Index &	npages,
		const Index &	nrows,
		const Index &	ncols,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Tensor6SetConstant.

Creates a tensor and sets all elements to the specified value.

The size is determined by ncols, nrows etc.

Author: Claudia Emde

Parameters

[out]	t	Generic output
[in]	nvitrines	WS Input
[in]	nshelves	WS Input
[in]	nbooks	WS Input
[in]	npages	WS Input
[in]	nrows	WS Input
[in]	ncols	WS Input
[in]	value	Generic Input

Definition at line 596 of file m_basic_types.cc.

References CREATE_OUT2, CREATE_OUT3, and Tensor6::resize().

Referenced by Tensor6SetConstant_g().

◆ Tensor7Scale()

void Tensor7Scale	(	Tensor7 &	tout,
		const Tensor7 &	tin,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Tensor7Scale.

Scales all elements of a tensor with the specified value.

The result can either be stored in the same or another variable.

Author: Mattias Ekstrom

Parameters

[out]	tout	Generic output
[in]	tin	Generic Input
[in]	value	Generic Input

Definition at line 623 of file m_basic_types.cc.

References ConstTensor7View::nbooks(), ConstTensor7View::ncols(), ConstTensor7View::nlibraries(), ConstTensor7View::npages(), ConstTensor7View::nrows(), ConstTensor7View::nshelves(), ConstTensor7View::nvitrines(), and Tensor7::resize().

Referenced by Tensor7Scale_g().

◆ Tensor7SetConstant()

void Tensor7SetConstant	(	Tensor7 &	t,
		const Index &	nlibraries,
		const Index &	nvitrines,
		const Index &	nshelves,
		const Index &	nbooks,
		const Index &	npages,
		const Index &	nrows,
		const Index &	ncols,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Tensor7SetConstant.

Creates a tensor and sets all elements to the specified value.

The size is determined by ncols, nrows etc.

Author: Claudia Emde

Parameters

[out]	t	Generic output
[in]	nlibraries	WS Input
[in]	nvitrines	WS Input
[in]	nshelves	WS Input
[in]	nbooks	WS Input
[in]	npages	WS Input
[in]	nrows	WS Input
[in]	ncols	WS Input
[in]	value	Generic Input

Definition at line 644 of file m_basic_types.cc.

References CREATE_OUT2, CREATE_OUT3, and Tensor7::resize().

Referenced by Tensor7SetConstant_g().

◆ VectorAddScalar()

void VectorAddScalar	(	Vector &	v1,
		const Vector &	v2,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: VectorAddScalar.

Adds a scalar to all elements of a vector.

The result can either be stored in the same or another vector.

Author: Patrick Eriksson

Parameters

[out]	v1	Generic output
[in]	v2	Generic Input
[in]	value	Generic Input

Definition at line 673 of file m_basic_types.cc.

References ConstVectorView::nelem(), and Vector::resize().

Referenced by abs_scalar_gasCalcLBL(), and VectorAddScalar_g().

◆ VectorFlip()

void VectorFlip	(	Vector &	gout1,
		const Vector &	gin1,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: VectorFlip.

Flips a vector.

The output is the input vector in reversed order. The result can either be stored in the same or another vector.

Author: Patrick Eriksson

Parameters

[out]	gout1	Generic output
[in]	gin1	Generic Input

Definition at line 696 of file m_basic_types.cc.

References ConstVectorView::nelem(), and Vector::resize().

Referenced by VectorFlip_g().

◆ VectorInsertGridPoints()

void VectorInsertGridPoints	(	Vector &	gout1,
		const Vector &	gin1,
		const Vector &	gin2,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: VectorInsertGridPoints.

Insert some additional points into a grid.

This method can for example be used to add line center frequencies to a regular frequency grid. If the original grid is [1,2,3], and the additional points are [2.2,2.4], the result will be [1,2,2.2,2.4,3].

It is assumed that the original grid is sorted, otherwise a runtime error is thrown. The vector with the points to insert does not have to be sorted. If some of the input points are already in the grid, these points are not inserted again. New points outside the original grid are appended at the appropriate end. Input vector and output vector can be the same.

Generic output: Vector : The new grid vector.

Generic input: Vector : The original grid vector. Vector : The points to insert.

Author: Stefan Buehler

Parameters

[out]	gout1	Generic output
[in]	gin1	Generic Input
[in]	gin2	Generic Input

Definition at line 720 of file m_basic_types.cc.

References arts_exit(), CREATE_OUT2, CREATE_OUT3, get_sorted_indexes(), is_decreasing(), is_increasing(), Array< base >::nelem(), ConstVectorView::nelem(), and Vector::resize().

Referenced by choose_abs_nls_pert(), and VectorInsertGridPoints_g().

◆ VectorLinSpace()

void VectorLinSpace	(	Vector &	v,
		const Numeric &	start,
		const Numeric &	stop,
		const Numeric &	step,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: VectorLinSpace.

Creates a vector with linear spacing.

The first element equals always the start value, and the spacing equals always the step value, but the last value can deviate from the stop value. step can be both positive and negative.

The created vector is [start, start+step, start+2*step, ...]

Author: Patrick Eriksson

Parameters

[out]	v	Generic output
[in]	start	Generic Input
[in]	stop	Generic Input
[in]	step	Generic Input

Definition at line 848 of file m_basic_types.cc.

References CREATE_OUT2, CREATE_OUT3, linspace(), and ConstVectorView::nelem().

Referenced by VectorLinSpace_g().

◆ VectorLogSpace()

void VectorLogSpace	(	Vector &	gout1,
		const Numeric &	start,
		const Numeric &	stop,
		const Numeric &	step,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: VectorLogSpace.

Creates a vector with logarithmic spacing.

The first element equals always the start value, and the spacing equals always the step value, but note that the last value can deviate from the stop value. The keyword step can be both positive and negative.

Note, that although start has to be given in direct coordinates, step has to be given in log coordinates.

Explicitly, the vector is: exp([ln(start), ln(start)+step, ln(start)+2*step, ...])

Author: Stefan Buehler

Parameters

[out]	gout1	Generic output
[in]	start	Generic Input
[in]	stop	Generic Input
[in]	step	Generic Input

Definition at line 871 of file m_basic_types.cc.

References CREATE_OUT2, CREATE_OUT3, linspace(), ConstVectorView::nelem(), and transform().

Referenced by VectorLogSpace_g().

◆ VectorMatrixMultiply()

void VectorMatrixMultiply	(	Vector &	gout1,
		const Matrix &	gin1,
		const Vector &	gin2,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: VectorMatrixMultiply.

Multiply a Vector with a Matrix and store the result in another Vector.

This just computes the normal Matrix-Vector product, y=M*x. It is ok if input and output Vector are the same. This function is handy for multiplying the H Matrix to spectra.

Author: Stefan Buehler

Parameters

[out]	gout1	Generic output
[in]	gin1	Generic Input
[in]	gin2	Generic Input

Definition at line 895 of file m_basic_types.cc.

References M, mult(), ConstVectorView::nelem(), and Vector::resize().

Referenced by VectorMatrixMultiply_g().

◆ VectorNLinSpace()

void VectorNLinSpace	(	Vector &	v,
		const Index &	nelem,
		const Numeric &	start,
		const Numeric &	stop,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: VectorNLinSpace.

Creates a vector with length nelem, equally spaced between the given end values.

The length (nelem) must be larger than 1.

Author: Patrick Eriksson

Parameters

[out]	v	Generic output
[in]	nelem	WS Input
[in]	start	Generic Input
[in]	stop	Generic Input

Definition at line 923 of file m_basic_types.cc.

References CREATE_OUT2, CREATE_OUT3, and nlinspace().

Referenced by VectorNLinSpace_g().

◆ VectorNLogSpace()

void VectorNLogSpace	(	Vector &	v,
		const Index &	nelem,
		const Numeric &	start,
		const Numeric &	stop,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: VectorNLogSpace.

Creates a vector with length nelem, equally logarithmically spaced between the given end values.

The length (nelem) must be larger than 1.

Author: Patrick Eriksson

Parameters

[out]	v	Generic output
[in]	nelem	WS Input
[in]	start	Generic Input
[in]	stop	Generic Input

Definition at line 949 of file m_basic_types.cc.

References CREATE_OUT2, CREATE_OUT3, and nlogspace().

Referenced by VectorNLogSpace_g(), ybatchMetProfiles(), and ybatchMetProfilesClear().

◆ VectorScale()

void VectorScale	(	Vector &	gout1,
		const Vector &	gin1,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: VectorScale.

Scales all elements of a vector with the same value.

The result can either be stored in the same or another vector.

Author: Patrick Eriksson

Parameters

[out]	gout1	Generic output
[in]	gin1	Generic Input
[in]	value	Generic Input

Definition at line 975 of file m_basic_types.cc.

References ConstVectorView::nelem(), and Vector::resize().

Referenced by VectorScale_g().

◆ VectorSet()

void VectorSet	(	Vector &	gout1,
		const Vector &	values,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: VectorSet.

Create a vector from the given list of numbers.

VectorSet(p_grid, [1000, 100, 10] ) Will create a p_grid vector with these three elements.

Author: Stefan Buehler

Parameters

[out]	gout1	Generic output
[in]	values	Generic Input

Definition at line 1016 of file m_basic_types.cc.

Referenced by VectorSet_g().

◆ VectorSetConstant()

void VectorSetConstant	(	Vector &	v,
		const Index &	nelem,
		const Numeric &	value,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: VectorSetConstant.

Creates a vector and sets all elements to the specified value.

The vector length is determined by nelem.

Author: Patrick Eriksson

Parameters

[out]	v	Generic output
[in]	nelem	WS Input
[in]	value	Generic Input

Definition at line 998 of file m_basic_types.cc.

References CREATE_OUT2, CREATE_OUT3, and Vector::resize().

Referenced by VectorSetConstant_g().

Functions

Detailed Description

Function Documentation

◆ ArrayOfIndexSet()

◆ ArrayOfIndexSetConstant()

◆ ArrayOfStringSet()

◆ FlagOff()

◆ FlagOn()

◆ IndexSet()

◆ IndexStep()

◆ Matrix1ColFromVector()

◆ Matrix1RowFromVector()

◆ Matrix2ColFromVectors()

◆ Matrix2RowFromVectors()

◆ Matrix3ColFromVectors()

◆ Matrix3RowFromVectors()

◆ MatrixCompare()

◆ MatrixMatrixMultiply()

◆ MatrixScale()

◆ MatrixSet()

◆ MatrixSetConstant()

◆ NumericAdd()

◆ NumericScale()

◆ NumericSet()

◆ SparseSparseMultiply()

◆ StringSet()

◆ Tensor3AddScalar()

◆ Tensor3Scale()

◆ Tensor3SetConstant()

◆ Tensor4Scale()

◆ Tensor4SetConstant()

◆ Tensor5Scale()

◆ Tensor5SetConstant()

◆ Tensor6Scale()

◆ Tensor6SetConstant()

◆ Tensor7Scale()

◆ Tensor7SetConstant()

◆ VectorAddScalar()

◆ VectorFlip()

◆ VectorInsertGridPoints()

◆ VectorLinSpace()

◆ VectorLogSpace()

◆ VectorMatrixMultiply()

◆ VectorNLinSpace()

◆ VectorNLogSpace()

◆ VectorScale()

◆ VectorSet()

◆ VectorSetConstant()