ARTS 2.5.11 (git: 725533f0)
Functions | Variables
m_basic_types.cc File Reference

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

#include <cmath>
#include <string_view>
#include "array.h"
#include "arts.h"
#include "arts_constants.h"
#include "artstime.h"
#include "energylevelmap.h"
#include "exceptions.h"
#include "gridded_fields.h"
#include "lin_alg.h"
#include "logic.h"
#include "math_funcs.h"
#include "matpack_data.h"
#include "matpack_arrays.h"
#include "matpack_math.h"
#include "messages.h"
#include "mystring.h"
#include "optproperties.h"
#include "quantum_numbers.h"
#include "sorting.h"

Go to the source code of this file.

Functions

void ArrayOfIndexSetConstant (ArrayOfIndex &aoi, const Index &nelem, const Index &value, const Verbosity &)
 WORKSPACE METHOD: ArrayOfIndexSetConstant.
 
void ArrayOfIndexLinSpace (ArrayOfIndex &x, const Index &start, const Index &stop, const Index &step, const Verbosity &verbosity)
 WORKSPACE METHOD: ArrayOfIndexLinSpace.
 
void FlagOff (Index &x, const Verbosity &)
 WORKSPACE METHOD: FlagOff.
 
void FlagOn (Index &x, const Verbosity &)
 WORKSPACE METHOD: FlagOn.
 
void IndexAdd (Index &out, const Index &in, const Index &value, const Verbosity &)
 WORKSPACE METHOD: IndexAdd.
 
void IndexDivide (Index &out, const Index &in, const Index &value, const Verbosity &)
 WORKSPACE METHOD: IndexDivide.
 
void IndexMultiply (Index &out, const Index &in, const Index &value, const Verbosity &)
 WORKSPACE METHOD: IndexMultiply.
 
void IndexStepDown (Index &xout, const Index &xin, const Verbosity &)
 WORKSPACE METHOD: IndexStepDown.
 
void IndexStepUp (Index &xout, const Index &xin, const Verbosity &)
 WORKSPACE METHOD: IndexStepUp.
 
void IndexSubtract (Index &out, const Index &in, const Index &value, const Verbosity &)
 WORKSPACE METHOD: IndexSubtract.
 
void MatrixAdd (Matrix &out, const Matrix &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: MatrixAdd.
 
void MatrixDivide (Matrix &out, const Matrix &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: MatrixDivide.
 
void MatrixGaussian (Matrix &Y, const Vector &x_row, const Numeric &x0_row, const Numeric &si_row, const Numeric &fwhm_row, const Vector &x_col, const Numeric &x0_col, const Numeric &si_col, const Numeric &fwhm_col, const Verbosity &)
 WORKSPACE METHOD: MatrixGaussian.
 
void MatrixMultiply (Matrix &out, const Matrix &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: MatrixMultiply.
 
void MatrixSubtract (Matrix &out, const Matrix &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: MatrixSubtract.
 
void MatrixCopySparse (Matrix &out, const Sparse &in, const Verbosity &)
 WORKSPACE METHOD: MatrixCopySparse.
 
void MatrixExtractFromTensor3 (Matrix &m, const Tensor3 &t3, const Index &index, const String &direction, const Verbosity &)
 WORKSPACE METHOD: MatrixExtractFromTensor3.
 
void MatrixMatrixMultiply (Matrix &Y, const Matrix &M, const Matrix &X, const Verbosity &)
 WORKSPACE METHOD: MatrixMatrixMultiply.
 
void Matrix1ColFromVector (Matrix &m, const Vector &v, const Verbosity &)
 WORKSPACE METHOD: Matrix1ColFromVector.
 
void Matrix2ColFromVectors (Matrix &m, const Vector &v1, const Vector &v2, const Verbosity &)
 WORKSPACE METHOD: Matrix2ColFromVectors.
 
void Matrix3ColFromVectors (Matrix &m, const Vector &v1, const Vector &v2, const Vector &v3, const Verbosity &)
 WORKSPACE METHOD: Matrix3ColFromVectors.
 
void Matrix1RowFromVector (Matrix &m, const Vector &v, const Verbosity &)
 WORKSPACE METHOD: Matrix1RowFromVector.
 
void Matrix2RowFromVectors (Matrix &m, const Vector &v1, const Vector &v2, const Verbosity &)
 WORKSPACE METHOD: Matrix2RowFromVectors.
 
void Matrix3RowFromVectors (Matrix &m, const Vector &v1, const Vector &v2, const Vector &v3, const Verbosity &)
 WORKSPACE METHOD: Matrix3RowFromVectors.
 
void MatrixIdentity (Matrix &out, const Index &n, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: MatrixIdentity.
 
void MatrixReshapeTensor3 (Matrix &m, const Tensor3 &t, const Verbosity &)
 WORKSPACE METHOD: MatrixReshapeTensor3.
 
void MatrixSetConstant (Matrix &x, const Index &nrows, const Index &ncols, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: MatrixSetConstant.
 
void NumericAdd (Numeric &out, const Numeric &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: NumericAdd.
 
void NumericClip (Numeric &out, const Numeric &in, const Numeric &limit_low, const Numeric &limit_high, const Verbosity &)
 WORKSPACE METHOD: NumericClip.
 
void NumericDivide (Numeric &out, const Numeric &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: NumericDivide.
 
void NumericFromVector (Numeric &out, const Vector &in, const String &op, const Verbosity &)
 WORKSPACE METHOD: NumericFromVector.
 
void NumericMultiply (Numeric &out, const Numeric &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: NumericMultiply.
 
void NumericSubtract (Numeric &out, const Numeric &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: NumericSubtract.
 
void RationalAdd (Rational &out, const Rational &in, const Rational &value, const Verbosity &)
 WORKSPACE METHOD: RationalAdd.
 
void RationalDivide (Rational &out, const Rational &in, const Rational &value, const Verbosity &)
 WORKSPACE METHOD: RationalDivide.
 
void RationalMultiply (Rational &out, const Rational &in, const Rational &value, const Verbosity &)
 WORKSPACE METHOD: RationalMultiply.
 
void RationalSubtract (Rational &out, const Rational &in, const Rational &value, const Verbosity &)
 WORKSPACE METHOD: RationalSubtract.
 
void SparseSparseMultiply (Sparse &Y, const Sparse &M, const Sparse &X, const Verbosity &)
 WORKSPACE METHOD: SparseSparseMultiply.
 
void SparseIdentity (Sparse &X, const Index &n, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: SparseIdentity.
 
void DiagonalMatrix (Matrix &X, const Vector &diag, const Verbosity &)
 WORKSPACE METHOD: DiagonalMatrix.
 
void DiagonalMatrix (Sparse &X, const Vector &diag, const Verbosity &)
 WORKSPACE METHOD: DiagonalMatrix.
 
void Tensor3Add (Tensor3 &out, const Tensor3 &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: Tensor3Add.
 
void Tensor3FromVector (Tensor3 &m, const Vector &v, const Verbosity &)
 WORKSPACE METHOD: Tensor3FromVector.
 
void Tensor3Multiply (Tensor3 &out, const Tensor3 &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: Tensor3Multiply.
 
void Tensor3SetConstant (Tensor3 &x, const Index &npages, const Index &nrows, const Index &ncols, const Numeric &value, const Verbosity &verbosity)
 WORKSPACE METHOD: Tensor3SetConstant.
 
void Tensor3ExtractFromTensor4 (Tensor3 &t3, const Tensor4 &t4, const Index &index, const String &direction, const Verbosity &)
 WORKSPACE METHOD: Tensor3ExtractFromTensor4.
 
void Tensor4Add (Tensor4 &out, const Tensor4 &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: Tensor4Add.
 
void Tensor4Multiply (Tensor4 &out, const Tensor4 &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: Tensor4Multiply.
 
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.
 
void Tensor5Multiply (Tensor5 &out, const Tensor5 &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: Tensor5Multiply.
 
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.
 
void Tensor6Multiply (Tensor6 &out, const Tensor6 &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: Tensor6Multiply.
 
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.
 
void Tensor7Multiply (Tensor7 &out, const Tensor7 &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: Tensor7Multiply.
 
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.
 
void Trapz (Numeric &out, const Vector &x, const Vector &y, const Verbosity &)
 WORKSPACE METHOD: Trapz.
 
void VectorAdd (Vector &out, const Vector &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: VectorAdd.
 
void VectorDivide (Vector &out, const Vector &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: VectorDivide.
 
void VectorMultiply (Vector &out, const Vector &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: VectorMultiply.
 
void VectorSubtract (Vector &out, const Vector &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: VectorSubtract.
 
void VectorAddElementwise (Vector &c, const Vector &a, const Vector &b, const Verbosity &)
 WORKSPACE METHOD: VectorAddElementwise.
 
void VectorSubtractElementwise (Vector &c, const Vector &a, const Vector &b, const Verbosity &)
 WORKSPACE METHOD: VectorSubtractElementwise.
 
void VectorMultiplyElementwise (Vector &c, const Vector &a, const Vector &b, const Verbosity &)
 WORKSPACE METHOD: VectorMultiplyElementwise.
 
void VectorDivideElementwise (Vector &c, const Vector &a, const Vector &b, const Verbosity &)
 WORKSPACE METHOD: VectorDivideElementwise.
 
void VectorClip (Vector &out, const Vector &in, const Numeric &limit_low, const Numeric &limit_high, const Verbosity &)
 WORKSPACE METHOD: VectorClip.
 
void VectorCrop (Vector &out, const Vector &in, const Numeric &min_value, const Numeric &max_value, const Verbosity &)
 WORKSPACE METHOD: VectorCrop.
 
void VectorExtractFromMatrix (Vector &v, const Matrix &m, const Index &index, const String &direction, const Verbosity &)
 WORKSPACE METHOD: VectorExtractFromMatrix.
 
void VectorFlip (Vector &out, const Vector &in, const Verbosity &)
 WORKSPACE METHOD: VectorFlip.
 
void VectorGaussian (Vector &y, const Vector &x, const Numeric &x0, const Numeric &si, const Numeric &fwhm, const Verbosity &)
 WORKSPACE METHOD: VectorGaussian.
 
void VectorInsertGridPoints (Vector &og, const Vector &ingrid, const Vector &points, const Verbosity &verbosity)
 WORKSPACE METHOD: VectorInsertGridPoints.
 
void VectorLinSpace (Vector &x, const Numeric &start, const Numeric &stop, const Numeric &step, const Verbosity &verbosity)
 WORKSPACE METHOD: VectorLinSpace.
 
void VectorLogSpace (Vector &x, const Numeric &start, const Numeric &stop, const Numeric &step, const Verbosity &verbosity)
 WORKSPACE METHOD: VectorLogSpace.
 
void VectorMatrixMultiply (Vector &y, const Matrix &M, const Vector &x, const Verbosity &)
 WORKSPACE METHOD: VectorMatrixMultiply.
 
void VectorSparseMultiply (Vector &y, const Sparse &M, const Vector &x, const Verbosity &)
 WORKSPACE METHOD: VectorSparseMultiply.
 
void VectorNLinSpace (Vector &x, const Index &n, const Numeric &start, const Numeric &stop, const Verbosity &verbosity)
 WORKSPACE METHOD: VectorNLinSpace.
 
void VectorNLinSpaceVector (Vector &x, const Index &n, const Vector &y, const Verbosity &verbosity)
 WORKSPACE METHOD: VectorNLinSpaceVector.
 
void ArrayOfTimeNLinSpace (ArrayOfTime &x, const Index &n, const String &start, const String &stop, const Verbosity &)
 WORKSPACE METHOD: ArrayOfTimeNLinSpace.
 
void VectorNLogSpace (Vector &x, const Index &n, const Numeric &start, const Numeric &stop, const Verbosity &verbosity)
 WORKSPACE METHOD: VectorNLogSpace.
 
void VectorPower (Vector &out, const Vector &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: VectorPower.
 
void VectorReshapeMatrix (Vector &v, const Matrix &m, const String &direction, const Verbosity &)
 WORKSPACE METHOD: VectorReshapeMatrix.
 
void VectorSetConstant (Vector &x, const Index &n, const Numeric &value, const Verbosity &verbosity)
 WORKSPACE METHOD: VectorSetConstant.
 
void ArrayOfTimeSetConstant (ArrayOfTime &x, const Index &n, const Time &value, const Verbosity &verbosity)
 WORKSPACE METHOD: ArrayOfTimeSetConstant.
 
void Compare (const Numeric &var1, const Numeric &var2, const Numeric &maxabsdiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: Compare.
 
void Compare (const Vector &var1, const Vector &var2, const Numeric &maxabsdiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: Compare.
 
void Compare (const Matrix &var1, const Matrix &var2, const Numeric &maxabsdiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: Compare.
 
void Compare (const Tensor3 &var1, const Tensor3 &var2, const Numeric &maxabsdiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: Compare.
 
void Compare (const Tensor4 &var1, const Tensor4 &var2, const Numeric &maxabsdiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: Compare.
 
void Compare (const Tensor5 &var1, const Tensor5 &var2, const Numeric &maxabsdiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: Compare.
 
void Compare (const Tensor7 &var1, const Tensor7 &var2, const Numeric &maxabsdiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: Compare.
 
void Compare (const ArrayOfVector &var1, const ArrayOfVector &var2, const Numeric &maxabsdiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: Compare.
 
void Compare (const ArrayOfMatrix &var1, const ArrayOfMatrix &var2, const Numeric &maxabsdiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: Compare.
 
void Compare (const ArrayOfTensor7 &var1, const ArrayOfTensor7 &var2, const Numeric &maxabsdiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: Compare.
 
void Compare (const GriddedField3 &var1, const GriddedField3 &var2, const Numeric &maxabsdiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: Compare.
 
void Compare (const Sparse &var1, const Sparse &var2, const Numeric &maxabsdiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: Compare.
 
void Compare (const SingleScatteringData &var1, const SingleScatteringData &var2, const Numeric &maxabsdiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: Compare.
 
void _cr_internal_ (const Numeric &var1, const Numeric &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &)
 
void _cr_internal_ (const ConstVectorView var1, const ConstVectorView var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 
void _cr_internal_ (const ConstMatrixView var1, const ConstMatrixView var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 
void _cr_internal_ (const ConstTensor3View var1, const ConstTensor3View var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 
void _cr_internal_ (const ConstTensor4View var1, const ConstTensor4View var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 
void _cr_internal_ (const ConstTensor5View var1, const ConstTensor5View var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 
void _cr_internal_ (const ConstTensor6View var1, const ConstTensor6View var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 
void _cr_internal_ (const ConstTensor7View var1, const ConstTensor7View var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 
void _cr_internal_ (const PropagationMatrix &var1, const PropagationMatrix &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 
void _cr_internal_ (const StokesVector &var1, const StokesVector &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 
template<class T >
void _cr_internal_ (const Array< T > &var1, const Array< T > &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 
void CompareRelative (const Numeric &var1, const Numeric &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const Vector &var1, const Vector &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const Matrix &var1, const Matrix &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const Tensor3 &var1, const Tensor3 &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const Tensor4 &var1, const Tensor4 &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const Tensor5 &var1, const Tensor5 &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const Tensor6 &var1, const Tensor6 &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const Tensor7 &var1, const Tensor7 &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const ArrayOfVector &var1, const ArrayOfVector &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const ArrayOfMatrix &var1, const ArrayOfMatrix &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const ArrayOfTensor3 &var1, const ArrayOfTensor3 &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const ArrayOfTensor4 &var1, const ArrayOfTensor4 &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const ArrayOfTensor5 &var1, const ArrayOfTensor5 &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 
void CompareRelative (const ArrayOfTensor6 &var1, const ArrayOfTensor6 &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const ArrayOfTensor7 &var1, const ArrayOfTensor7 &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const ArrayOfArrayOfVector &var1, const ArrayOfArrayOfVector &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const ArrayOfArrayOfMatrix &var1, const ArrayOfArrayOfMatrix &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const ArrayOfArrayOfTensor3 &var1, const ArrayOfArrayOfTensor3 &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const ArrayOfArrayOfTensor4 &var1, const ArrayOfArrayOfTensor4 &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 
void CompareRelative (const ArrayOfArrayOfTensor5 &var1, const ArrayOfArrayOfTensor5 &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 
void CompareRelative (const ArrayOfArrayOfTensor6 &var1, const ArrayOfArrayOfTensor6 &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const ArrayOfArrayOfTensor7 &var1, const ArrayOfArrayOfTensor7 &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 
void CompareRelative (const PropagationMatrix &var1, const PropagationMatrix &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const ArrayOfPropagationMatrix &var1, const ArrayOfPropagationMatrix &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const ArrayOfArrayOfPropagationMatrix &var1, const ArrayOfArrayOfPropagationMatrix &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const StokesVector &var1, const StokesVector &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const ArrayOfStokesVector &var1, const ArrayOfStokesVector &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const ArrayOfArrayOfStokesVector &var1, const ArrayOfArrayOfStokesVector &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void CompareRelative (const EnergyLevelMap &var1, const EnergyLevelMap &var2, const Numeric &maxabsreldiff, const String &error_message, const String &var1name, const String &var2name, const String &, const String &, const Verbosity &verbosity)
 WORKSPACE METHOD: CompareRelative.
 
void PrintPhysicalConstants (const Verbosity &verbosity)
 WORKSPACE METHOD: PrintPhysicalConstants.
 

Variables

constexpr Numeric PI =Constant::pi
 
constexpr Numeric NAT_LOG_2 =Constant::ln_2
 

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@c.nosp@m.halme.nosp@m.rs.s.nosp@m.e
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:

  1. Initiation of variables by keyword arguments, such as StringSet.
  2. Basic math, such as VectorMatrixMultiply.

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

◆ _cr_internal_() [1/11]

template<class T >
void _cr_internal_ ( const Array< T > &  var1,
const Array< T > &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1name,
const String &  var2name,
const String &  ,
const String &  ,
const Verbosity &  verbosity 
)
inline

Definition at line 2684 of file m_basic_types.cc.

◆ _cr_internal_() [2/11]

void _cr_internal_ ( const ConstMatrixView  var1,
const ConstMatrixView  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1name,
const String &  var2name,
const String &  ,
const String &  ,
const Verbosity &  verbosity 
)
inline

Definition at line 2499 of file m_basic_types.cc.

◆ _cr_internal_() [3/11]

void _cr_internal_ ( const ConstTensor3View  var1,
const ConstTensor3View  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1name,
const String &  var2name,
const String &  ,
const String &  ,
const Verbosity &  verbosity 
)
inline

Definition at line 2523 of file m_basic_types.cc.

◆ _cr_internal_() [4/11]

void _cr_internal_ ( const ConstTensor4View  var1,
const ConstTensor4View  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1name,
const String &  var2name,
const String &  ,
const String &  ,
const Verbosity &  verbosity 
)
inline

Definition at line 2547 of file m_basic_types.cc.

◆ _cr_internal_() [5/11]

void _cr_internal_ ( const ConstTensor5View  var1,
const ConstTensor5View  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1name,
const String &  var2name,
const String &  ,
const String &  ,
const Verbosity &  verbosity 
)
inline

Definition at line 2571 of file m_basic_types.cc.

◆ _cr_internal_() [6/11]

void _cr_internal_ ( const ConstTensor6View  var1,
const ConstTensor6View  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1name,
const String &  var2name,
const String &  ,
const String &  ,
const Verbosity &  verbosity 
)
inline

Definition at line 2595 of file m_basic_types.cc.

◆ _cr_internal_() [7/11]

void _cr_internal_ ( const ConstTensor7View  var1,
const ConstTensor7View  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1name,
const String &  var2name,
const String &  ,
const String &  ,
const Verbosity &  verbosity 
)
inline

Definition at line 2619 of file m_basic_types.cc.

◆ _cr_internal_() [8/11]

void _cr_internal_ ( const ConstVectorView  var1,
const ConstVectorView  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1name,
const String &  var2name,
const String &  ,
const String &  ,
const Verbosity &  verbosity 
)
inline

Definition at line 2475 of file m_basic_types.cc.

◆ _cr_internal_() [9/11]

void _cr_internal_ ( const Numeric &  var1,
const Numeric &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1name,
const String &  var2name,
const String &  ,
const String &  ,
const Verbosity &   
)
inline

Definition at line 2449 of file m_basic_types.cc.

◆ _cr_internal_() [10/11]

void _cr_internal_ ( const PropagationMatrix &  var1,
const PropagationMatrix &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1name,
const String &  var2name,
const String &  ,
const String &  ,
const Verbosity &  verbosity 
)
inline

Definition at line 2643 of file m_basic_types.cc.

◆ _cr_internal_() [11/11]

void _cr_internal_ ( const StokesVector &  var1,
const StokesVector &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1name,
const String &  var2name,
const String &  ,
const String &  ,
const Verbosity &  verbosity 
)
inline

Definition at line 2663 of file m_basic_types.cc.

◆ ArrayOfIndexLinSpace()

void ArrayOfIndexLinSpace ( ArrayOfIndex &  output,
const Index &  start,
const Index &  stop,
const Index &  step,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: ArrayOfIndexLinSpace.

Initializes an ArrayOfIndex 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 array is [start, start+step, start+2*step, ...] <br>

Author
Oliver Lemke
Parameters
[out]outputGeneric output
[in]startGeneric Input
[in]stopGeneric Input
[in]stepGeneric Input

Definition at line 64 of file m_basic_types.cc.

References CREATE_OUT2, CREATE_OUT3, and Array< base >::nelem().

Referenced by ArrayOfIndexLinSpace_g().

◆ ArrayOfIndexSetConstant()

void ArrayOfIndexSetConstant ( ArrayOfIndex &  output,
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]outputGeneric output
[in]nelemWS Input
[in]valueGeneric Input

Definition at line 55 of file m_basic_types.cc.

Referenced by ArrayOfIndexSetConstant_g().

◆ ArrayOfTimeNLinSpace()

void ArrayOfTimeNLinSpace ( ArrayOfTime &  output,
const Index &  nelem,
const String &  start,
const String &  stop,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: ArrayOfTimeNLinSpace.

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

The length (nelem) must be larger than 1.

Author
Richard Larsson
Parameters
[out]outputGeneric output
[in]nelemWS Input
[in]startGeneric Input
[in]stopGeneric Input

Definition at line 1558 of file m_basic_types.cc.

References ARTS_USER_ERROR_IF.

Referenced by ArrayOfTimeNLinSpace_g().

◆ ArrayOfTimeSetConstant()

void ArrayOfTimeSetConstant ( ArrayOfTime &  output,
const Index &  nelem,
const Time &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: ArrayOfTimeSetConstant.

Creates an ArrayOfTime and sets all elements to the specified value.

The vector length is determined by nelem.

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]nelemWS Input
[in]valueGeneric Input

Definition at line 1663 of file m_basic_types.cc.

Referenced by ArrayOfTimeSetConstant_g().

◆ Compare() [1/13]

void Compare ( const ArrayOfMatrix &  var1,
const ArrayOfMatrix &  var2,
const Numeric &  maxabsdiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsdiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Compare.

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsdiffGeneric Input (Default: "")
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsdiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2175 of file m_basic_types.cc.

◆ Compare() [2/13]

void Compare ( const ArrayOfTensor7 &  var1,
const ArrayOfTensor7 &  var2,
const Numeric &  maxabsdiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsdiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Compare.

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsdiffGeneric Input (Default: "")
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsdiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2220 of file m_basic_types.cc.

◆ Compare() [3/13]

void Compare ( const ArrayOfVector &  var1,
const ArrayOfVector &  var2,
const Numeric &  maxabsdiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsdiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Compare.

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsdiffGeneric Input (Default: "")
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsdiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2130 of file m_basic_types.cc.

◆ Compare() [4/13]

void Compare ( const GriddedField3 &  var1,
const GriddedField3 &  var2,
const Numeric &  maxabsdiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsdiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Compare.

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsdiffGeneric Input (Default: "")
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsdiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2265 of file m_basic_types.cc.

◆ Compare() [5/13]

void Compare ( const Matrix &  var1,
const Matrix &  var2,
const Numeric &  maxabsdiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsdiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Compare.

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsdiffGeneric Input (Default: "")
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsdiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 1783 of file m_basic_types.cc.

◆ Compare() [6/13]

void Compare ( const Numeric &  var1,
const Numeric &  var2,
const Numeric &  maxabsdiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsdiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Compare.

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsdiffGeneric Input (Default: "")
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsdiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 1679 of file m_basic_types.cc.

Referenced by Compare_sg_ArrayOfMatrixArrayOfMatrix_g(), Compare_sg_ArrayOfTensor7ArrayOfTensor7_g(), Compare_sg_ArrayOfVectorArrayOfVector_g(), Compare_sg_GriddedField3GriddedField3_g(), Compare_sg_MatrixMatrix_g(), Compare_sg_NumericNumeric_g(), Compare_sg_SingleScatteringDataSingleScatteringData_g(), Compare_sg_SparseSparse_g(), Compare_sg_Tensor3Tensor3_g(), Compare_sg_Tensor4Tensor4_g(), Compare_sg_Tensor5Tensor5_g(), Compare_sg_Tensor7Tensor7_g(), and Compare_sg_VectorVector_g().

◆ Compare() [7/13]

void Compare ( const SingleScatteringData &  var1,
const SingleScatteringData &  var2,
const Numeric &  maxabsdiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsdiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Compare.

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsdiffGeneric Input (Default: "")
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsdiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2368 of file m_basic_types.cc.

◆ Compare() [8/13]

void Compare ( const Sparse &  var1,
const Sparse &  var2,
const Numeric &  maxabsdiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsdiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Compare.

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsdiffGeneric Input (Default: "")
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsdiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2303 of file m_basic_types.cc.

◆ Compare() [9/13]

void Compare ( const Tensor3 &  var1,
const Tensor3 &  var2,
const Numeric &  maxabsdiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsdiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Compare.

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsdiffGeneric Input (Default: "")
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsdiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 1848 of file m_basic_types.cc.

◆ Compare() [10/13]

void Compare ( const Tensor4 &  var1,
const Tensor4 &  var2,
const Numeric &  maxabsdiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsdiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Compare.

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsdiffGeneric Input (Default: "")
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsdiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 1913 of file m_basic_types.cc.

◆ Compare() [11/13]

void Compare ( const Tensor5 &  var1,
const Tensor5 &  var2,
const Numeric &  maxabsdiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsdiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Compare.

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsdiffGeneric Input (Default: "")
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsdiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 1980 of file m_basic_types.cc.

◆ Compare() [12/13]

void Compare ( const Tensor7 &  var1,
const Tensor7 &  var2,
const Numeric &  maxabsdiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsdiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Compare.

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsdiffGeneric Input (Default: "")
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsdiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2052 of file m_basic_types.cc.

◆ Compare() [13/13]

void Compare ( const Vector &  var1,
const Vector &  var2,
const Numeric &  maxabsdiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsdiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Compare.

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsdiffGeneric Input (Default: "")
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsdiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 1723 of file m_basic_types.cc.

◆ CompareRelative() [1/29]

void CompareRelative ( const ArrayOfArrayOfMatrix &  var1,
const ArrayOfArrayOfMatrix &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 3013 of file m_basic_types.cc.

◆ CompareRelative() [2/29]

void CompareRelative ( const ArrayOfArrayOfPropagationMatrix &  var1,
const ArrayOfArrayOfPropagationMatrix &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 3168 of file m_basic_types.cc.

◆ CompareRelative() [3/29]

void CompareRelative ( const ArrayOfArrayOfStokesVector &  var1,
const ArrayOfArrayOfStokesVector &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 3228 of file m_basic_types.cc.

◆ CompareRelative() [4/29]

void CompareRelative ( const ArrayOfArrayOfTensor3 &  var1,
const ArrayOfArrayOfTensor3 &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 3032 of file m_basic_types.cc.

◆ CompareRelative() [5/29]

void CompareRelative ( const ArrayOfArrayOfTensor4 &  var1,
const ArrayOfArrayOfTensor4 &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1name,
const String &  var2name,
const String &  ,
const String &  ,
const Verbosity &  verbosity 
)

Definition at line 3051 of file m_basic_types.cc.

◆ CompareRelative() [6/29]

void CompareRelative ( const ArrayOfArrayOfTensor5 &  var1,
const ArrayOfArrayOfTensor5 &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1name,
const String &  var2name,
const String &  ,
const String &  ,
const Verbosity &  verbosity 
)

Definition at line 3070 of file m_basic_types.cc.

◆ CompareRelative() [7/29]

void CompareRelative ( const ArrayOfArrayOfTensor6 &  var1,
const ArrayOfArrayOfTensor6 &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 3089 of file m_basic_types.cc.

◆ CompareRelative() [8/29]

void CompareRelative ( const ArrayOfArrayOfTensor7 &  var1,
const ArrayOfArrayOfTensor7 &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1name,
const String &  var2name,
const String &  ,
const String &  ,
const Verbosity &  verbosity 
)

Definition at line 3108 of file m_basic_types.cc.

◆ CompareRelative() [9/29]

void CompareRelative ( const ArrayOfArrayOfVector &  var1,
const ArrayOfArrayOfVector &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2994 of file m_basic_types.cc.

◆ CompareRelative() [10/29]

void CompareRelative ( const ArrayOfMatrix &  var1,
const ArrayOfMatrix &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2880 of file m_basic_types.cc.

◆ CompareRelative() [11/29]

void CompareRelative ( const ArrayOfPropagationMatrix &  var1,
const ArrayOfPropagationMatrix &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 3148 of file m_basic_types.cc.

◆ CompareRelative() [12/29]

void CompareRelative ( const ArrayOfStokesVector &  var1,
const ArrayOfStokesVector &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 3208 of file m_basic_types.cc.

◆ CompareRelative() [13/29]

void CompareRelative ( const ArrayOfTensor3 &  var1,
const ArrayOfTensor3 &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2899 of file m_basic_types.cc.

◆ CompareRelative() [14/29]

void CompareRelative ( const ArrayOfTensor4 &  var1,
const ArrayOfTensor4 &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2918 of file m_basic_types.cc.

◆ CompareRelative() [15/29]

void CompareRelative ( const ArrayOfTensor5 &  var1,
const ArrayOfTensor5 &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1name,
const String &  var2name,
const String &  ,
const String &  ,
const Verbosity &  verbosity 
)

Definition at line 2937 of file m_basic_types.cc.

◆ CompareRelative() [16/29]

void CompareRelative ( const ArrayOfTensor6 &  var1,
const ArrayOfTensor6 &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2956 of file m_basic_types.cc.

◆ CompareRelative() [17/29]

void CompareRelative ( const ArrayOfTensor7 &  var1,
const ArrayOfTensor7 &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2975 of file m_basic_types.cc.

◆ CompareRelative() [18/29]

void CompareRelative ( const ArrayOfVector &  var1,
const ArrayOfVector &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2861 of file m_basic_types.cc.

◆ CompareRelative() [19/29]

void CompareRelative ( const EnergyLevelMap &  var1,
const EnergyLevelMap &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 3249 of file m_basic_types.cc.

◆ CompareRelative() [20/29]

void CompareRelative ( const Matrix &  var1,
const Matrix &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2747 of file m_basic_types.cc.

◆ CompareRelative() [21/29]

void CompareRelative ( const Numeric &  var1,
const Numeric &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2709 of file m_basic_types.cc.

Referenced by CompareRelative_sg_ArrayOfArrayOfMatrixArrayOfArrayOfMatrix_g(), CompareRelative_sg_ArrayOfArrayOfPropagationMatrixArrayOfArrayOfPropagationMatrix_g(), CompareRelative_sg_ArrayOfArrayOfStokesVectorArrayOfArrayOfStokesVector_g(), CompareRelative_sg_ArrayOfArrayOfTensor3ArrayOfArrayOfTensor3_g(), CompareRelative_sg_ArrayOfArrayOfTensor6ArrayOfArrayOfTensor6_g(), CompareRelative_sg_ArrayOfArrayOfVectorArrayOfArrayOfVector_g(), CompareRelative_sg_ArrayOfMatrixArrayOfMatrix_g(), CompareRelative_sg_ArrayOfPropagationMatrixArrayOfPropagationMatrix_g(), CompareRelative_sg_ArrayOfStokesVectorArrayOfStokesVector_g(), CompareRelative_sg_ArrayOfTensor3ArrayOfTensor3_g(), CompareRelative_sg_ArrayOfTensor4ArrayOfTensor4_g(), CompareRelative_sg_ArrayOfTensor6ArrayOfTensor6_g(), CompareRelative_sg_ArrayOfTensor7ArrayOfTensor7_g(), CompareRelative_sg_ArrayOfVectorArrayOfVector_g(), CompareRelative_sg_EnergyLevelMapEnergyLevelMap_g(), CompareRelative_sg_MatrixMatrix_g(), CompareRelative_sg_NumericNumeric_g(), CompareRelative_sg_PropagationMatrixPropagationMatrix_g(), CompareRelative_sg_StokesVectorStokesVector_g(), CompareRelative_sg_Tensor3Tensor3_g(), CompareRelative_sg_Tensor4Tensor4_g(), CompareRelative_sg_Tensor5Tensor5_g(), CompareRelative_sg_Tensor6Tensor6_g(), CompareRelative_sg_Tensor7Tensor7_g(), and CompareRelative_sg_VectorVector_g().

◆ CompareRelative() [22/29]

void CompareRelative ( const PropagationMatrix &  var1,
const PropagationMatrix &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 3128 of file m_basic_types.cc.

◆ CompareRelative() [23/29]

void CompareRelative ( const StokesVector &  var1,
const StokesVector &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 3188 of file m_basic_types.cc.

◆ CompareRelative() [24/29]

void CompareRelative ( const Tensor3 &  var1,
const Tensor3 &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2766 of file m_basic_types.cc.

◆ CompareRelative() [25/29]

void CompareRelative ( const Tensor4 &  var1,
const Tensor4 &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2785 of file m_basic_types.cc.

◆ CompareRelative() [26/29]

void CompareRelative ( const Tensor5 &  var1,
const Tensor5 &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2804 of file m_basic_types.cc.

◆ CompareRelative() [27/29]

void CompareRelative ( const Tensor6 &  var1,
const Tensor6 &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2823 of file m_basic_types.cc.

◆ CompareRelative() [28/29]

void CompareRelative ( const Tensor7 &  var1,
const Tensor7 &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2842 of file m_basic_types.cc.

◆ CompareRelative() [29/29]

void CompareRelative ( const Vector &  var1,
const Vector &  var2,
const Numeric &  maxabsreldiff,
const String &  error_message,
const String &  var1_wsvname,
const String &  var2_wsvname,
const String &  maxabsreldiff_wsvname,
const String &  error_message_wsvname,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: CompareRelative.

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in]var1Generic Input
[in]var2Generic Input
[in]maxabsreldiffGeneric Input
[in]error_messageGeneric Input (Default: "")
[in]var1_wsvnameGeneric Input Name
[in]var2_wsvnameGeneric Input Name
[in]maxabsreldiff_wsvnameGeneric Input Name
[in]error_message_wsvnameGeneric Input Name

Definition at line 2728 of file m_basic_types.cc.

◆ DiagonalMatrix() [1/2]

void DiagonalMatrix ( Matrix &  output,
const Vector &  v,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: DiagonalMatrix.

Create a diagonal matrix from a vector.

This creates a dense or sparse diagonal matrix with the elements of the given vector on the diagonal.

Author
Simon Pfreundschuh
Parameters
[out]outputSupergeneric output
[in]vGeneric Input

Definition at line 613 of file m_basic_types.cc.

Referenced by DiagonalMatrix_sg_Matrix_g(), and DiagonalMatrix_sg_Sparse_g().

◆ DiagonalMatrix() [2/2]

void DiagonalMatrix ( Sparse &  output,
const Vector &  v,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: DiagonalMatrix.

Create a diagonal matrix from a vector.

This creates a dense or sparse diagonal matrix with the elements of the given vector on the diagonal.

Author
Simon Pfreundschuh
Parameters
[out]outputSupergeneric output
[in]vGeneric Input

Definition at line 624 of file m_basic_types.cc.

◆ FlagOff()

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

WORKSPACE METHOD: FlagOff.

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

Author
Patrick Eriksson
Parameters
[out]flagGeneric output

Definition at line 90 of file m_basic_types.cc.

Referenced by FlagOff_g().

◆ FlagOn()

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

WORKSPACE METHOD: FlagOn.

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

Author
Patrick Eriksson
Parameters
[out]flagGeneric output

Definition at line 93 of file m_basic_types.cc.

Referenced by FlagOn_g().

◆ IndexAdd()

void IndexAdd ( Index &  output,
const Index &  input,
const Index &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: IndexAdd.

Adds a Index and a value (output = input + value).

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

Author
Patrick Eriksson, Oliver Lemke
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 96 of file m_basic_types.cc.

Referenced by IndexAdd_g().

◆ IndexDivide()

void IndexDivide ( Index &  output,
const Index &  input,
const Index &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: IndexDivide.

Integer division of a Index and a value (output = input / value).

Please note that integer divison is applied, and e.g. 5/3=1.

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

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 104 of file m_basic_types.cc.

Referenced by IndexDivide_g().

◆ IndexMultiply()

void IndexMultiply ( Index &  output,
const Index &  input,
const Index &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: IndexMultiply.

Multiplies a Index and a value (output = input * value).

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

Author
Patrick Eriksson, Oliver Lemke
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 112 of file m_basic_types.cc.

Referenced by IndexMultiply_g().

◆ IndexStepDown()

void IndexStepDown ( Index &  output,
const Index &  input,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: IndexStepDown.

Performas: output = input - 1

Input and output can be same variable.

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input

Definition at line 120 of file m_basic_types.cc.

Referenced by IndexStepDown_g().

◆ IndexStepUp()

void IndexStepUp ( Index &  output,
const Index &  input,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: IndexStepUp.

Performas: output = input + 1

Input and output can be same variable.

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input

Definition at line 125 of file m_basic_types.cc.

Referenced by IndexStepUp_g().

◆ IndexSubtract()

void IndexSubtract ( Index &  output,
const Index &  input,
const Index &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: IndexSubtract.

Subtracts a Index value (output = input - value).

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

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 130 of file m_basic_types.cc.

Referenced by IndexSubtract_g().

◆ Matrix1ColFromVector()

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

WORKSPACE METHOD: Matrix1ColFromVector.

Forms a matrix containing one column from a vector.

Author
Mattias Ekstrom
Parameters
[out]outputGeneric output
[in]vGeneric Input

Definition at line 337 of file m_basic_types.cc.

References v.

Referenced by Matrix1ColFromVector_g().

◆ Matrix1RowFromVector()

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

WORKSPACE METHOD: Matrix1RowFromVector.

Forms a matrix containing one row from a vector.

Author
Mattias Ekstrom
Parameters
[out]outputGeneric output
[in]vGeneric Input

Definition at line 385 of file m_basic_types.cc.

References v.

Referenced by Matrix1RowFromVector_g().

◆ Matrix2ColFromVectors()

void Matrix2ColFromVectors ( Matrix &  output,
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]outputGeneric output
[in]v1Generic Input
[in]v2Generic Input

Definition at line 349 of file m_basic_types.cc.

Referenced by Matrix2ColFromVectors_g().

◆ Matrix2RowFromVectors()

void Matrix2RowFromVectors ( Matrix &  output,
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]outputGeneric output
[in]v1Generic Input
[in]v2Generic Input

Definition at line 397 of file m_basic_types.cc.

Referenced by Matrix2RowFromVectors_g().

◆ Matrix3ColFromVectors()

void Matrix3ColFromVectors ( Matrix &  output,
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]outputGeneric output
[in]v1Generic Input
[in]v2Generic Input
[in]v3Generic Input

Definition at line 366 of file m_basic_types.cc.

Referenced by Matrix3ColFromVectors_g().

◆ Matrix3RowFromVectors()

void Matrix3RowFromVectors ( Matrix &  output,
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]outputGeneric output
[in]v1Generic Input
[in]v2Generic Input
[in]v3Generic Input

Definition at line 414 of file m_basic_types.cc.

Referenced by Matrix3RowFromVectors_g().

◆ MatrixAdd()

void MatrixAdd ( Matrix &  output,
const Matrix &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: MatrixAdd.

Adds a scalar to all elements of a matrix.

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

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 138 of file m_basic_types.cc.

Referenced by MatrixAdd_g().

◆ MatrixCopySparse()

void MatrixCopySparse ( Matrix &  output,
const Sparse &  input,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: MatrixCopySparse.

Creates a matrix by copying a variable of type Sparse.

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input

Definition at line 250 of file m_basic_types.cc.

References c.

Referenced by MatrixCopySparse_g().

◆ MatrixDivide()

void MatrixDivide ( Matrix &  output,
const Matrix &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: MatrixDivide.

Divides 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]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 156 of file m_basic_types.cc.

Referenced by MatrixDivide_g().

◆ MatrixExtractFromTensor3()

void MatrixExtractFromTensor3 ( Matrix &  output,
const Tensor3 &  input,
const Index &  i,
const String &  direction,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: MatrixExtractFromTensor3.

Extracts a Matrix from a Tensor3.

Copies page or row or column with given Index from input Tensor3 variable to output Matrix. Higher order equivalent of VectorExtractFromMatrix.

Author
Jana Mendrok
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]iGeneric Input
[in]directionGeneric Input

Definition at line 261 of file m_basic_types.cc.

Referenced by MatrixExtractFromTensor3_g().

◆ MatrixGaussian()

void MatrixGaussian ( Matrix &  Y,
const Vector &  x_row,
const Numeric &  x0_row,
const Numeric &  si_row,
const Numeric &  fwhm_row,
const Vector &  x_col,
const Numeric &  x0_col,
const Numeric &  si_col,
const Numeric &  fwhm_col,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: MatrixGaussian.

Fills a matrix with a Gaussian function.

Works as VectorGaussian but grid, mean and si/fwhm must be specified for each dimension.

Author
Patrick Eriksson
Parameters
[out]YGeneric output
[in]x_rowGeneric Input
[in]x0_rowGeneric Input (Default: "0")
[in]si_rowGeneric Input (Default: "-1")
[in]fwhm_rowGeneric Input (Default: "-1")
[in]x_colGeneric Input
[in]x0_colGeneric Input (Default: "0")
[in]si_colGeneric Input (Default: "-1")
[in]fwhm_colGeneric Input (Default: "-1")

Definition at line 174 of file m_basic_types.cc.

References ARTS_USER_ERROR_IF, c, fac(), NAT_LOG_2, and PI.

Referenced by MatrixGaussian_g().

◆ MatrixIdentity()

void MatrixIdentity ( Matrix &  output,
const Index &  n,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: MatrixIdentity.

Returns the identity matrix.

The size if the matrix created is n x n. Default is to return a true identity matrix (I), but you can also select another value along the diagonal by setting value. That is, the output is value * I.

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]nGeneric Input
[in]valueGeneric Input (Default: "1")

Definition at line 433 of file m_basic_types.cc.

Referenced by MatrixIdentity_g().

◆ MatrixMatrixMultiply()

void MatrixMatrixMultiply ( Matrix &  Y,
const Matrix &  M,
const Matrix &  X,
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.

Author
Stefan Buehler
Parameters
[out]YGeneric output
[in]MGeneric Input
[in]XGeneric Input

Definition at line 309 of file m_basic_types.cc.

References mult().

Referenced by MatrixMatrixMultiply_g().

◆ MatrixMultiply()

void MatrixMultiply ( Matrix &  output,
const Matrix &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: MatrixMultiply.

Multiplies 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]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 214 of file m_basic_types.cc.

Referenced by MatrixMultiply_g().

◆ MatrixReshapeTensor3()

void MatrixReshapeTensor3 ( Matrix &  output,
const Tensor3 &  input,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: MatrixReshapeTensor3.

Creates a matrix as reshaped version of a tenor3.

If the size of the tensor is [npages, nrows, ncols], the created matrix gets size [npages * nrows, ncols]. The matrix is filled with the tensor's page dimension as the outermost loop.

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input

Definition at line 446 of file m_basic_types.cc.

Referenced by MatrixReshapeTensor3_g().

◆ MatrixSetConstant()

void MatrixSetConstant ( Matrix &  output,
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]outputGeneric output
[in]nrowsWS Input
[in]ncolsWS Input
[in]valueGeneric Input

Definition at line 465 of file m_basic_types.cc.

Referenced by MatrixSetConstant_g().

◆ MatrixSubtract()

void MatrixSubtract ( Matrix &  output,
const Matrix &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: MatrixSubtract.

Subtracts a scalar from all elements of a matrix.

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

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 232 of file m_basic_types.cc.

Referenced by MatrixSubtract_g().

◆ NumericAdd()

void NumericAdd ( Numeric &  output,
const Numeric &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: NumericAdd.

Adds a Numeric and a value (output = input + value).

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

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 475 of file m_basic_types.cc.

Referenced by NumericAdd_g().

◆ NumericClip()

void NumericClip ( Numeric &  output,
const Numeric &  input,
const Numeric &  limit_low,
const Numeric &  limit_high,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: NumericClip.

Clipping of a Numeric.

The input value is copied to the output one (that can be same WSV) but ensures that out is inside the range [limit_low,limit_high]. When the input value is below limit_low, output is set to limit_low. And the same is performed with respect to limit_high.

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]limit_lowGeneric Input (Default: "-Inf")
[in]limit_highGeneric Input (Default: "Inf")

Definition at line 483 of file m_basic_types.cc.

Referenced by NumericClip_g().

◆ NumericDivide()

void NumericDivide ( Numeric &  output,
const Numeric &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: NumericDivide.

Divides a Numeric with a value (output = input / value).

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

Author
Jana Mendrok
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 497 of file m_basic_types.cc.

Referenced by NumericDivide_g().

◆ NumericFromVector()

void NumericFromVector ( Numeric &  output,
const Vector &  input,
const String &  op,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: NumericFromVector.

Derivs a Numeric from a vector, following selected operation.

The following operations can be selected:

  • "first": Selects the first element of the vector.
  • "last": Selects the last element of the vector.
  • "max": Selects the maximum element of the vector.
  • "min": Selects the minimum element of the vector.

  • "mean": Calculates the mean of the vector.

    Author
    Patrick Eriksson
    Parameters
    [out]outputGeneric output
    [in]inputGeneric Input
    [in]opGeneric Input

Definition at line 505 of file m_basic_types.cc.

References max(), mean(), and min().

Referenced by NumericFromVector_g().

◆ NumericMultiply()

void NumericMultiply ( Numeric &  output,
const Numeric &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: NumericMultiply.

Multiplies a Numeric with a value (output = input * value).

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

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 528 of file m_basic_types.cc.

Referenced by NumericMultiply_g().

◆ NumericSubtract()

void NumericSubtract ( Numeric &  output,
const Numeric &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: NumericSubtract.

Subtracts a Numeric value (output = input - value).

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

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 536 of file m_basic_types.cc.

Referenced by NumericSubtract_g().

◆ PrintPhysicalConstants()

void PrintPhysicalConstants ( const Verbosity &  verbosity)

WORKSPACE METHOD: PrintPhysicalConstants.

Prints (most) physical constants used in ARTS.

Author
Richard Larsson

Definition at line 3278 of file m_basic_types.cc.

Referenced by PrintPhysicalConstants_g().

◆ RationalAdd()

void RationalAdd ( Rational &  output,
const Rational &  input,
const Rational &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: RationalAdd.

Adds a Rational and a value (output = input + value).

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

Author
Richard Larsson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 544 of file m_basic_types.cc.

Referenced by RationalAdd_g().

◆ RationalDivide()

void RationalDivide ( Rational &  output,
const Rational &  input,
const Rational &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: RationalDivide.

Divides a Rational with a value (output = input / value).

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

Author
Richard Larsson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 552 of file m_basic_types.cc.

Referenced by RationalDivide_g().

◆ RationalMultiply()

void RationalMultiply ( Rational &  output,
const Rational &  input,
const Rational &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: RationalMultiply.

Multiplies a Rational with a value (output = input * value).

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

Author
Richard Larsson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 560 of file m_basic_types.cc.

Referenced by RationalMultiply_g().

◆ RationalSubtract()

void RationalSubtract ( Rational &  output,
const Rational &  input,
const Rational &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: RationalSubtract.

Subtracts a Rational value (output = input - value).

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

Author
Richard Larsson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 568 of file m_basic_types.cc.

Referenced by RationalSubtract_g().

◆ SparseIdentity()

void SparseIdentity ( Sparse &  output,
const Index &  n,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: SparseIdentity.

Returns a sparse dentity matrix.

The size of the matrix created is n x n. Default is to return a true identity matrix (I), but you can also select another value along the diagonal be setting value. That is, the output is value*I.

Author
Simon Pfreundschuh
Parameters
[out]outputGeneric output
[in]nGeneric Input
[in]valueGeneric Input (Default: "1")

Definition at line 602 of file m_basic_types.cc.

Referenced by SparseIdentity_g().

◆ SparseSparseMultiply()

void SparseSparseMultiply ( Sparse &  M,
const Sparse &  M1,
const Sparse &  M2,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: SparseSparseMultiply.

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

Makes the calculation: M = M1 * M2

Author
Patrick Eriksson
Parameters
[out]MGeneric output
[in]M1Generic Input
[in]M2Generic Input

Definition at line 577 of file m_basic_types.cc.

References mult().

Referenced by SparseSparseMultiply_g().

◆ Tensor3Add()

void Tensor3Add ( Tensor3 &  output,
const Tensor3 &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Tensor3Add.

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]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 638 of file m_basic_types.cc.

Referenced by Tensor3Add_g().

◆ Tensor3ExtractFromTensor4()

void Tensor3ExtractFromTensor4 ( Tensor3 &  output,
const Tensor4 &  input,
const Index &  i,
const String &  direction,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Tensor3ExtractFromTensor4.

Extracts a Tensor3 from a Tensor4.

Copies book, page, row or column with given Index from input Tensor4 variable to output Tensor3. Higher order equivalent of VectorExtractFromMatrix.

Author
Oliver Lemke
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]iGeneric Input
[in]directionGeneric Input

Definition at line 705 of file m_basic_types.cc.

Referenced by Tensor3ExtractFromTensor4_g().

◆ Tensor3FromVector()

void Tensor3FromVector ( Tensor3 &  output,
const Vector &  v,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Tensor3FromVector.

Forms a Tensor3 of size nx1x1 from a vector of length n.

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]vGeneric Input

Definition at line 656 of file m_basic_types.cc.

References v.

Referenced by Tensor3FromVector_g().

◆ Tensor3Multiply()

void Tensor3Multiply ( Tensor3 &  output,
const Tensor3 &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Tensor3Multiply.

Multiplies 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]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 668 of file m_basic_types.cc.

Referenced by Tensor3Multiply_g().

◆ Tensor3SetConstant()

void Tensor3SetConstant ( Tensor3 &  output,
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]outputGeneric output
[in]npagesWS Input
[in]nrowsWS Input
[in]ncolsWS Input
[in]valueGeneric Input

Definition at line 686 of file m_basic_types.cc.

References CREATE_OUT2, and CREATE_OUT3.

Referenced by Tensor3SetConstant_g().

◆ Tensor4Add()

void Tensor4Add ( Tensor4 &  output,
const Tensor4 &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Tensor4Add.

Adds a scalar value to all elements of a tensor4.

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

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 764 of file m_basic_types.cc.

Referenced by Tensor4Add_g().

◆ Tensor4Multiply()

void Tensor4Multiply ( Tensor4 &  output,
const Tensor4 &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Tensor4Multiply.

Multiplies 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]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 782 of file m_basic_types.cc.

Referenced by Tensor4Multiply_g().

◆ Tensor4SetConstant()

void Tensor4SetConstant ( Tensor4 &  output,
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]outputGeneric output
[in]nbooksWS Input
[in]npagesWS Input
[in]nrowsWS Input
[in]ncolsWS Input
[in]valueGeneric Input

Definition at line 800 of file m_basic_types.cc.

References CREATE_OUT2, and CREATE_OUT3.

Referenced by Tensor4SetConstant_g().

◆ Tensor5Multiply()

void Tensor5Multiply ( Tensor5 &  output,
const Tensor5 &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Tensor5Multiply.

Multiplies 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]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 821 of file m_basic_types.cc.

Referenced by Tensor5Multiply_g().

◆ Tensor5SetConstant()

void Tensor5SetConstant ( Tensor5 &  output,
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]outputGeneric output
[in]nshelvesWS Input
[in]nbooksWS Input
[in]npagesWS Input
[in]nrowsWS Input
[in]ncolsWS Input
[in]valueGeneric Input

Definition at line 839 of file m_basic_types.cc.

References CREATE_OUT2, and CREATE_OUT3.

Referenced by Tensor5SetConstant_g().

◆ Tensor6Multiply()

void Tensor6Multiply ( Tensor6 &  output,
const Tensor6 &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Tensor6Multiply.

Multiplies 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]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 862 of file m_basic_types.cc.

Referenced by Tensor6Multiply_g().

◆ Tensor6SetConstant()

void Tensor6SetConstant ( Tensor6 &  output,
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]outputGeneric output
[in]nvitrinesWS Input
[in]nshelvesWS Input
[in]nbooksWS Input
[in]npagesWS Input
[in]nrowsWS Input
[in]ncolsWS Input
[in]valueGeneric Input

Definition at line 885 of file m_basic_types.cc.

References CREATE_OUT2, and CREATE_OUT3.

Referenced by Tensor6SetConstant_g().

◆ Tensor7Multiply()

void Tensor7Multiply ( Tensor7 &  output,
const Tensor7 &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Tensor7Multiply.

Multiplies 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]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 910 of file m_basic_types.cc.

Referenced by Tensor7Multiply_g().

◆ Tensor7SetConstant()

void Tensor7SetConstant ( Tensor7 &  output,
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]outputGeneric output
[in]nlibrariesWS Input
[in]nvitrinesWS Input
[in]nshelvesWS Input
[in]nbooksWS Input
[in]npagesWS Input
[in]nrowsWS Input
[in]ncolsWS Input
[in]valueGeneric Input

Definition at line 934 of file m_basic_types.cc.

References CREATE_OUT2, and CREATE_OUT3.

Referenced by Tensor7SetConstant_g().

◆ Trapz()

void Trapz ( Numeric &  output,
const Vector &  x,
const Vector &  y,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: Trapz.

Intregrates a vector of over its grid range

The method integrates y(x) by the trapezoidal method.

The vector x is the positions where the integrand, y, is known.

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]xGeneric Input
[in]yGeneric Input

Definition at line 961 of file m_basic_types.cc.

Referenced by Trapz_g().

◆ VectorAdd()

void VectorAdd ( Vector &  output,
const Vector &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorAdd.

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]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 976 of file m_basic_types.cc.

Referenced by VectorAdd_g().

◆ VectorAddElementwise()

void VectorAddElementwise ( Vector &  c,
const Vector &  a,
const Vector &  b,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorAddElementwise.

Element-wise addition of two vectors.

The method calculates c = a + b.

The variable b is allowed to have length 1, for any length of a. This single value in b is then added to every element of a.

The vectors a and c can be the same WSV, while b can not be the same WSV as any of the the other vector.

Author
Patrick Eriksson
Parameters
[out]cGeneric output
[in]aGeneric Input
[in]bGeneric Input

Definition at line 1048 of file m_basic_types.cc.

References a, b, and c.

Referenced by VectorAddElementwise_g().

◆ VectorClip()

void VectorClip ( Vector &  output,
const Vector &  input,
const Numeric &  limit_low,
const Numeric &  limit_high,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorClip.

Clipping of a vector.

The input vector is copied to the output one (that can be same WSV) but ensures that all values in output are inside the range [limit_low, limit_high]. Where the input vector is below limit_low, out is set to limit_low. And the same is performed with respect to limit_high. That is, the method works as NumericClip for each element of the vector.

The method adopts the length of out when needed.

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]limit_lowGeneric Input (Default: "-Inf")
[in]limit_highGeneric Input (Default: "Inf")

Definition at line 1192 of file m_basic_types.cc.

Referenced by VectorClip_g().

◆ VectorCrop()

void VectorCrop ( Vector &  output,
const Vector &  input,
const Numeric &  min_value,
const Numeric &  max_value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorCrop.

Keeps only values of a vector inside the specified range.

All values outside the range [min_value,max-value] are removed. Note the default values, that basically should act as -+Inf.

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

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]min_valueGeneric Input (Default: "-99e99")
[in]max_valueGeneric Input (Default: "99e99")

Definition at line 1212 of file m_basic_types.cc.

References c.

Referenced by VectorCrop_g().

◆ VectorDivide()

void VectorDivide ( Vector &  output,
const Vector &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorDivide.

Divides 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]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 994 of file m_basic_types.cc.

Referenced by VectorDivide_g().

◆ VectorDivideElementwise()

void VectorDivideElementwise ( Vector &  c,
const Vector &  a,
const Vector &  b,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorDivideElementwise.

Element-wise division of two vectors.

The method calculates c = a / b.

The variable b is allowed to have length 1, for any length of a. This single value in b is then applied to every element of a.

The vectors a and c can be the same WSV, while b can not be the same WSV as any of the the other vector.

Author
Patrick Eriksson
Parameters
[out]cGeneric output
[in]aGeneric Input
[in]bGeneric Input

Definition at line 1156 of file m_basic_types.cc.

References a, b, and c.

Referenced by VectorDivideElementwise_g().

◆ VectorExtractFromMatrix()

void VectorExtractFromMatrix ( Vector &  output,
const Matrix &  input,
const Index &  i,
const String &  direction,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorExtractFromMatrix.

Extracts a Vector from a Matrix.

Copies row or column with given Index from input Matrix variable to create output Vector.

Author
Patrick Eriksson, Oliver Lemke, Stefan Buehler
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]iGeneric Input
[in]directionGeneric Input

Definition at line 1249 of file m_basic_types.cc.

References v.

Referenced by VectorExtractFromMatrix_g().

◆ VectorFlip()

void VectorFlip ( Vector &  output,
const Vector &  input,
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]outputGeneric output
[in]inputGeneric Input

Definition at line 1287 of file m_basic_types.cc.

References v.

Referenced by VectorFlip_g().

◆ VectorGaussian()

void VectorGaussian ( Vector &  y,
const Vector &  x,
const Numeric &  x0,
const Numeric &  si,
const Numeric &  fwhm,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorGaussian.

Fills a vector with a Gaussian function.

The width can be set in two ways, either by standard deviation or the full width at half maximum. Only one of the corresponding GINs can be >0 and that value will determine the width.

The vectors x and y can be the same variable.

Author
Patrick Eriksson
Parameters
[out]yGeneric output
[in]xGeneric Input
[in]x0Generic Input (Default: "0")
[in]siGeneric Input (Default: "-1")
[in]fwhmGeneric Input (Default: "-1")

Definition at line 1303 of file m_basic_types.cc.

References ARTS_USER_ERROR_IF, fac(), NAT_LOG_2, and PI.

Referenced by dlosGauss(), and VectorGaussian_g().

◆ VectorInsertGridPoints()

void VectorInsertGridPoints ( Vector &  output,
const Vector &  input,
const Vector &  points,
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: <br> - Vector : The new grid vector.

Generic input: <br> - Vector : The original grid vector. <br> - Vector : The points to insert.

Author
Stefan Buehler
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]pointsGeneric Input

Definition at line 1329 of file m_basic_types.cc.

References ARTS_ASSERT, arts_exit(), CREATE_OUT2, CREATE_OUT3, get_sorted_indexes(), and Array< base >::nelem().

Referenced by VectorInsertGridPoints_g().

◆ VectorLinSpace()

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

WORKSPACE METHOD: VectorLinSpace.

Initializes 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, ...] <br>

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]startGeneric Input
[in]stopGeneric Input
[in]stepGeneric Input

Definition at line 1433 of file m_basic_types.cc.

References CREATE_OUT2, CREATE_OUT3, and linspace().

Referenced by VectorLinSpace_g().

◆ VectorLogSpace()

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

WORKSPACE METHOD: VectorLogSpace.

Initializes 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: <br> exp([ln(start), ln(start)+step, ln(start)+2*step, ...])

Author
Stefan Buehler
Parameters
[out]outputGeneric output
[in]startGeneric Input
[in]stopGeneric Input
[in]stepGeneric Input

Definition at line 1454 of file m_basic_types.cc.

References CREATE_OUT2, CREATE_OUT3, and linspace().

Referenced by RadarOnionPeelingTableCalc(), and VectorLogSpace_g().

◆ VectorMatrixMultiply()

void VectorMatrixMultiply ( Vector &  y,
const Matrix &  M,
const Vector &  x,
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.

Author
Stefan Buehler
Parameters
[out]yGeneric output
[in]MGeneric Input
[in]xGeneric Input

Definition at line 1476 of file m_basic_types.cc.

References mult().

Referenced by VectorMatrixMultiply_g().

◆ VectorMultiply()

void VectorMultiply ( Vector &  output,
const Vector &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorMultiply.

Multiplies 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]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 1012 of file m_basic_types.cc.

Referenced by VectorMultiply_g().

◆ VectorMultiplyElementwise()

void VectorMultiplyElementwise ( Vector &  c,
const Vector &  a,
const Vector &  b,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorMultiplyElementwise.

Element-wise multiplication of two vectors.

The method calculates c = a * b.

The variable b is allowed to have length 1, for any length of a. This single value in b is then multiplied with every element of a.

The vectors a and c can be the same WSV, while b can not be the same WSV as any of the the other vector.

Author
Patrick Eriksson
Parameters
[out]cGeneric output
[in]aGeneric Input
[in]bGeneric Input

Definition at line 1120 of file m_basic_types.cc.

References a, b, and c.

Referenced by VectorMultiplyElementwise_g().

◆ VectorNLinSpace()

void VectorNLinSpace ( Vector &  output,
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]outputGeneric output
[in]nelemWS Input
[in]startGeneric Input
[in]stopGeneric Input

Definition at line 1528 of file m_basic_types.cc.

References CREATE_OUT2, CREATE_OUT3, and nlinspace().

Referenced by VectorNLinSpace_g(), and VectorNLinSpaceVector().

◆ VectorNLinSpaceVector()

void VectorNLinSpaceVector ( Vector &  output,
const Index &  nelem,
const Vector &  y,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorNLinSpaceVector.

As VectorNLinSpace but end points taken from a vector.

The method gives a vector with equidistant spacing between first and last element of the reference vector.

The length (nelem) must be larger than 1.

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]nelemWS Input
[in]yGeneric Input

Definition at line 1550 of file m_basic_types.cc.

References last(), and VectorNLinSpace().

Referenced by VectorNLinSpaceVector_g().

◆ VectorNLogSpace()

void VectorNLogSpace ( Vector &  output,
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]outputGeneric output
[in]nelemWS Input
[in]startGeneric Input
[in]stopGeneric Input

Definition at line 1573 of file m_basic_types.cc.

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

◆ VectorPower()

void VectorPower ( Vector &  output,
const Vector &  input,
const Numeric &  power,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorPower.

Calculates the power of each element in a vector.

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

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]powerGeneric Input

Definition at line 1596 of file m_basic_types.cc.

Referenced by VectorPower_g().

◆ VectorReshapeMatrix()

void VectorReshapeMatrix ( Vector &  output,
const Matrix &  input,
const String &  direction,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorReshapeMatrix.

Converts a Matrix to a Vector.

The matrix is reshaped into a vector. That is, all elements of the matrix are kept. The elements can be extracted both in column (default) and row order. The output vector has the same length for both options.

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]directionGeneric Input (Default: "column")

Definition at line 1613 of file m_basic_types.cc.

Referenced by VectorReshapeMatrix_g().

◆ VectorSetConstant()

void VectorSetConstant ( Vector &  output,
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]outputGeneric output
[in]nelemWS Input
[in]valueGeneric Input

Definition at line 1647 of file m_basic_types.cc.

Referenced by VectorSetConstant_g().

◆ VectorSparseMultiply()

void VectorSparseMultiply ( Vector &  y,
const Sparse &  M,
const Vector &  x,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorSparseMultiply.

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

This just computes the normal matrix-vector product, y=M*x, with m being a Sparse. It is ok if input and output Vector are the same.

Author
Patrick Eriksson
Parameters
[out]yGeneric output
[in]MGeneric Input
[in]xGeneric Input

Definition at line 1502 of file m_basic_types.cc.

References mult().

Referenced by VectorSparseMultiply_g().

◆ VectorSubtract()

void VectorSubtract ( Vector &  output,
const Vector &  input,
const Numeric &  value,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorSubtract.

Subtracts a scalar from all elements of a vector.

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

Author
Patrick Eriksson
Parameters
[out]outputGeneric output
[in]inputGeneric Input
[in]valueGeneric Input

Definition at line 1030 of file m_basic_types.cc.

Referenced by VectorSubtract_g().

◆ VectorSubtractElementwise()

void VectorSubtractElementwise ( Vector &  c,
const Vector &  a,
const Vector &  b,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: VectorSubtractElementwise.

Element-wise subtraction of two vectors.

The method calculates c = a - b.

The variable b is allowed to have length 1, for any length of a. This single value in b is then subtracted to every element of a.

The vectors a and c can be the same WSV, while b can not be the same WSV as any of the the other vector.

Author
Patrick Eriksson
Parameters
[out]cGeneric output
[in]aGeneric Input
[in]bGeneric Input

Definition at line 1084 of file m_basic_types.cc.

References a, b, and c.

Referenced by VectorSubtractElementwise_g().

Variable Documentation

◆ NAT_LOG_2

constexpr Numeric NAT_LOG_2 =Constant::ln_2
inlineconstexpr

Definition at line 48 of file m_basic_types.cc.

Referenced by MatrixGaussian(), and VectorGaussian().

◆ PI

constexpr Numeric PI =Constant::pi
inlineconstexpr

Definition at line 47 of file m_basic_types.cc.

Referenced by MatrixGaussian(), and VectorGaussian().