ARTS 2.5.9 (git: 825fa5f2)
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 "matpackI.h"
#include "matpackII.h"
#include "matpackIII.h"
#include "matpackIV.h"
#include "matpackV.h"
#include "matpackVI.h"
#include "matpackVII.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. More...
 
void ArrayOfIndexLinSpace (ArrayOfIndex &x, const Index &start, const Index &stop, const Index &step, const Verbosity &verbosity)
 WORKSPACE METHOD: ArrayOfIndexLinSpace. More...
 
void FlagOff (Index &x, const Verbosity &)
 WORKSPACE METHOD: FlagOff. More...
 
void FlagOn (Index &x, const Verbosity &)
 WORKSPACE METHOD: FlagOn. More...
 
void IndexAdd (Index &out, const Index &in, const Index &value, const Verbosity &)
 WORKSPACE METHOD: IndexAdd. More...
 
void IndexDivide (Index &out, const Index &in, const Index &value, const Verbosity &)
 WORKSPACE METHOD: IndexDivide. More...
 
void IndexMultiply (Index &out, const Index &in, const Index &value, const Verbosity &)
 WORKSPACE METHOD: IndexMultiply. More...
 
void IndexStepDown (Index &xout, const Index &xin, const Verbosity &)
 WORKSPACE METHOD: IndexStepDown. More...
 
void IndexStepUp (Index &xout, const Index &xin, const Verbosity &)
 WORKSPACE METHOD: IndexStepUp. More...
 
void IndexSubtract (Index &out, const Index &in, const Index &value, const Verbosity &)
 WORKSPACE METHOD: IndexSubtract. More...
 
void MatrixAdd (Matrix &out, const Matrix &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: MatrixAdd. More...
 
void MatrixDivide (Matrix &out, const Matrix &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: MatrixDivide. More...
 
void MatrixMultiply (Matrix &out, const Matrix &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: MatrixMultiply. More...
 
void MatrixSubtract (Matrix &out, const Matrix &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: MatrixSubtract. More...
 
void MatrixCopySparse (Matrix &out, const Sparse &in, const Verbosity &)
 WORKSPACE METHOD: MatrixCopySparse. More...
 
void MatrixExtractFromTensor3 (Matrix &m, const Tensor3 &t3, const Index &index, const String &direction, const Verbosity &)
 WORKSPACE METHOD: MatrixExtractFromTensor3. More...
 
void MatrixMatrixMultiply (Matrix &Y, const Matrix &M, const Matrix &X, const Verbosity &)
 WORKSPACE METHOD: MatrixMatrixMultiply. More...
 
void Matrix1ColFromVector (Matrix &m, const Vector &v, const Verbosity &)
 WORKSPACE METHOD: Matrix1ColFromVector. More...
 
void Matrix2ColFromVectors (Matrix &m, const Vector &v1, const Vector &v2, const Verbosity &)
 WORKSPACE METHOD: Matrix2ColFromVectors. More...
 
void Matrix3ColFromVectors (Matrix &m, const Vector &v1, const Vector &v2, const Vector &v3, const Verbosity &)
 WORKSPACE METHOD: Matrix3ColFromVectors. More...
 
void Matrix1RowFromVector (Matrix &m, const Vector &v, const Verbosity &)
 WORKSPACE METHOD: Matrix1RowFromVector. More...
 
void Matrix2RowFromVectors (Matrix &m, const Vector &v1, const Vector &v2, const Verbosity &)
 WORKSPACE METHOD: Matrix2RowFromVectors. More...
 
void Matrix3RowFromVectors (Matrix &m, const Vector &v1, const Vector &v2, const Vector &v3, const Verbosity &)
 WORKSPACE METHOD: Matrix3RowFromVectors. More...
 
void MatrixIdentity (Matrix &out, const Index &n, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: MatrixIdentity. More...
 
void MatrixSetConstant (Matrix &x, const Index &nrows, const Index &ncols, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: MatrixSetConstant. More...
 
void NumericAdd (Numeric &out, const Numeric &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: NumericAdd. More...
 
void NumericClip (Numeric &out, const Numeric &in, const Numeric &limit_low, const Numeric &limit_high, const Verbosity &)
 WORKSPACE METHOD: NumericClip. More...
 
void NumericDivide (Numeric &out, const Numeric &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: NumericDivide. More...
 
void NumericFromVector (Numeric &out, const Vector &in, const String &op, const Verbosity &)
 WORKSPACE METHOD: NumericFromVector. More...
 
void NumericMultiply (Numeric &out, const Numeric &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: NumericMultiply. More...
 
void NumericSubtract (Numeric &out, const Numeric &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: NumericSubtract. More...
 
void RationalAdd (Rational &out, const Rational &in, const Rational &value, const Verbosity &)
 WORKSPACE METHOD: RationalAdd. More...
 
void RationalDivide (Rational &out, const Rational &in, const Rational &value, const Verbosity &)
 WORKSPACE METHOD: RationalDivide. More...
 
void RationalMultiply (Rational &out, const Rational &in, const Rational &value, const Verbosity &)
 WORKSPACE METHOD: RationalMultiply. More...
 
void RationalSubtract (Rational &out, const Rational &in, const Rational &value, const Verbosity &)
 WORKSPACE METHOD: RationalSubtract. More...
 
void SparseSparseMultiply (Sparse &Y, const Sparse &M, const Sparse &X, const Verbosity &)
 WORKSPACE METHOD: SparseSparseMultiply. More...
 
void SparseIdentity (Sparse &X, const Index &n, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: SparseIdentity. More...
 
void DiagonalMatrix (Matrix &X, const Vector &diag, const Verbosity &)
 WORKSPACE METHOD: DiagonalMatrix. More...
 
void DiagonalMatrix (Sparse &X, const Vector &diag, const Verbosity &)
 WORKSPACE METHOD: DiagonalMatrix. More...
 
void Tensor3Add (Tensor3 &out, const Tensor3 &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: Tensor3Add. More...
 
void Tensor3FromVector (Tensor3 &m, const Vector &v, const Verbosity &)
 WORKSPACE METHOD: Tensor3FromVector. More...
 
void Tensor3Multiply (Tensor3 &out, const Tensor3 &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: Tensor3Multiply. More...
 
void Tensor3SetConstant (Tensor3 &x, const Index &npages, const Index &nrows, const Index &ncols, const Numeric &value, const Verbosity &verbosity)
 WORKSPACE METHOD: Tensor3SetConstant. More...
 
void Tensor3ExtractFromTensor4 (Tensor3 &t3, const Tensor4 &t4, const Index &index, const String &direction, const Verbosity &)
 WORKSPACE METHOD: Tensor3ExtractFromTensor4. More...
 
void Tensor4Add (Tensor4 &out, const Tensor4 &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: Tensor4Add. More...
 
void Tensor4Multiply (Tensor4 &out, const Tensor4 &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: Tensor4Multiply. More...
 
void Tensor4SetConstant (Tensor4 &x, const Index &nbooks, const Index &npages, const Index &nrows, const Index &ncols, const Numeric &value, const Verbosity &verbosity)
 WORKSPACE METHOD: Tensor4SetConstant. More...
 
void Tensor5Multiply (Tensor5 &out, const Tensor5 &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: Tensor5Multiply. More...
 
void Tensor5SetConstant (Tensor5 &x, const Index &nshelves, const Index &nbooks, const Index &npages, const Index &nrows, const Index &ncols, const Numeric &value, const Verbosity &verbosity)
 WORKSPACE METHOD: Tensor5SetConstant. More...
 
void Tensor6Multiply (Tensor6 &out, const Tensor6 &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: Tensor6Multiply. More...
 
void Tensor6SetConstant (Tensor6 &x, const Index &nvitrines, const Index &nshelves, const Index &nbooks, const Index &npages, const Index &nrows, const Index &ncols, const Numeric &value, const Verbosity &verbosity)
 WORKSPACE METHOD: Tensor6SetConstant. More...
 
void Tensor7Multiply (Tensor7 &out, const Tensor7 &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: Tensor7Multiply. More...
 
void Tensor7SetConstant (Tensor7 &x, const Index &nlibraries, const Index &nvitrines, const Index &nshelves, const Index &nbooks, const Index &npages, const Index &nrows, const Index &ncols, const Numeric &value, const Verbosity &verbosity)
 WORKSPACE METHOD: Tensor7SetConstant. More...
 
void Trapz (Numeric &out, const Vector &x, const Vector &y, const Verbosity &)
 WORKSPACE METHOD: Trapz. More...
 
void VectorAdd (Vector &out, const Vector &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: VectorAdd. More...
 
void VectorDivide (Vector &out, const Vector &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: VectorDivide. More...
 
void VectorMultiply (Vector &out, const Vector &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: VectorMultiply. More...
 
void VectorSubtract (Vector &out, const Vector &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: VectorSubtract. More...
 
void VectorAddElementwise (Vector &c, const Vector &a, const Vector &b, const Verbosity &)
 WORKSPACE METHOD: VectorAddElementwise. More...
 
void VectorSubtractElementwise (Vector &c, const Vector &a, const Vector &b, const Verbosity &)
 WORKSPACE METHOD: VectorSubtractElementwise. More...
 
void VectorMultiplyElementwise (Vector &c, const Vector &a, const Vector &b, const Verbosity &)
 WORKSPACE METHOD: VectorMultiplyElementwise. More...
 
void VectorDivideElementwise (Vector &c, const Vector &a, const Vector &b, const Verbosity &)
 WORKSPACE METHOD: VectorDivideElementwise. More...
 
void VectorClip (Vector &out, const Vector &in, const Numeric &limit_low, const Numeric &limit_high, const Verbosity &)
 WORKSPACE METHOD: VectorClip. More...
 
void VectorCrop (Vector &out, const Vector &in, const Numeric &min_value, const Numeric &max_value, const Verbosity &)
 WORKSPACE METHOD: VectorCrop. More...
 
void VectorExtractFromMatrix (Vector &v, const Matrix &m, const Index &index, const String &direction, const Verbosity &)
 WORKSPACE METHOD: VectorExtractFromMatrix. More...
 
void VectorFlip (Vector &out, const Vector &in, const Verbosity &)
 WORKSPACE METHOD: VectorFlip. More...
 
void VectorInsertGridPoints (Vector &og, const Vector &ingrid, const Vector &points, const Verbosity &verbosity)
 WORKSPACE METHOD: VectorInsertGridPoints. More...
 
void VectorLinSpace (Vector &x, const Numeric &start, const Numeric &stop, const Numeric &step, const Verbosity &verbosity)
 WORKSPACE METHOD: VectorLinSpace. More...
 
void VectorLogSpace (Vector &x, const Numeric &start, const Numeric &stop, const Numeric &step, const Verbosity &verbosity)
 WORKSPACE METHOD: VectorLogSpace. More...
 
void VectorMatrixMultiply (Vector &y, const Matrix &M, const Vector &x, const Verbosity &)
 WORKSPACE METHOD: VectorMatrixMultiply. More...
 
void VectorSparseMultiply (Vector &y, const Sparse &M, const Vector &x, const Verbosity &)
 WORKSPACE METHOD: VectorSparseMultiply. More...
 
void VectorNLinSpace (Vector &x, const Index &n, const Numeric &start, const Numeric &stop, const Verbosity &verbosity)
 WORKSPACE METHOD: VectorNLinSpace. More...
 
void ArrayOfTimeNLinSpace (ArrayOfTime &x, const Index &n, const String &start, const String &stop, const Verbosity &)
 WORKSPACE METHOD: ArrayOfTimeNLinSpace. More...
 
void VectorNLogSpace (Vector &x, const Index &n, const Numeric &start, const Numeric &stop, const Verbosity &verbosity)
 WORKSPACE METHOD: VectorNLogSpace. More...
 
void VectorPower (Vector &out, const Vector &in, const Numeric &value, const Verbosity &)
 WORKSPACE METHOD: VectorPower. More...
 
void VectorReshapeMatrix (Vector &v, const Matrix &m, const String &direction, const Verbosity &)
 WORKSPACE METHOD: VectorReshapeMatrix. More...
 
void VectorSetConstant (Vector &x, const Index &n, const Numeric &value, const Verbosity &verbosity)
 WORKSPACE METHOD: VectorSetConstant. More...
 
void ArrayOfTimeSetConstant (ArrayOfTime &x, const Index &n, const Time &value, const Verbosity &verbosity)
 WORKSPACE METHOD: ArrayOfTimeSetConstant. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
void PrintPhysicalConstants (const Verbosity &verbosity)
 WORKSPACE METHOD: PrintPhysicalConstants. More...
 

Detailed Description

Workspace functions for straightforward operations on variables of basic types.

Author
Patrick Eriksson Patri.nosp@m.ck.E.nosp@m.rikss.nosp@m.on@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 2610 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 2425 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 2449 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 2473 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 2497 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 2521 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 2545 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 2401 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 2375 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 2569 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 2589 of file m_basic_types.cc.

◆ ArrayOfIndexLinSpace()

void ArrayOfIndexLinSpace ( ArrayOfIndex out,
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]outGeneric output
[in]startGeneric Input
[in]stopGeneric Input
[in]stepGeneric Input

Definition at line 84 of file m_basic_types.cc.

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

Referenced by ArrayOfIndexLinSpace_g().

◆ ArrayOfIndexSetConstant()

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

Definition at line 75 of file m_basic_types.cc.

Referenced by ArrayOfIndexSetConstant_g().

◆ ArrayOfTimeNLinSpace()

void ArrayOfTimeNLinSpace ( ArrayOfTime out,
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]outGeneric output
[in]nelemWS Input
[in]startGeneric Input
[in]stopGeneric Input

Definition at line 1484 of file m_basic_types.cc.

References ARTS_USER_ERROR_IF.

Referenced by ArrayOfTimeNLinSpace_g().

◆ ArrayOfTimeSetConstant()

void ArrayOfTimeSetConstant ( ArrayOfTime out,
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]outGeneric output
[in]nelemWS Input
[in]valueGeneric Input

Definition at line 1589 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 2101 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 2146 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 2056 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 2191 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 1709 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 1605 of file m_basic_types.cc.

◆ 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 2294 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 2229 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 1774 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 1839 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 1906 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 1978 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 1649 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 2939 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 3094 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 3154 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 2958 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 2977 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 2996 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 3015 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 3034 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 2920 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 2806 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 3074 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 3134 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 2825 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 2844 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 2863 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 2882 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 2901 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 2787 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 3175 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 2673 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 2635 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 3054 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 3114 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 2692 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 2711 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 2730 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 2749 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 2768 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 2654 of file m_basic_types.cc.

◆ DiagonalMatrix() [1/2]

void DiagonalMatrix ( Matrix out,
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 <br> on the diagonal.

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

Definition at line 573 of file m_basic_types.cc.

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

Referenced by DiagonalMatrix_sg_Matrix_g(), and DiagonalMatrix_sg_Sparse_g().

◆ DiagonalMatrix() [2/2]

void DiagonalMatrix ( Sparse out,
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 <br> on the diagonal.

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

Definition at line 584 of file m_basic_types.cc.

References Sparse::insert_elements(), ConstVectorView::nelem(), and Sparse::resize().

◆ 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 110 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 113 of file m_basic_types.cc.

Referenced by FlagOn_g().

◆ IndexAdd()

void IndexAdd ( Index out,
const Index in,
const Index value,
const Verbosity verbosity 
)

WORKSPACE METHOD: IndexAdd.

Adds a Index and a value (out = in + value).

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

Author
Patrick Eriksson, Oliver Lemke
Parameters
[out]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 116 of file m_basic_types.cc.

Referenced by IndexAdd_g().

◆ IndexDivide()

void IndexDivide ( Index out,
const Index in,
const Index value,
const Verbosity verbosity 
)

WORKSPACE METHOD: IndexDivide.

Integer division of a Index and a value (out = in / 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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 124 of file m_basic_types.cc.

Referenced by IndexDivide_g().

◆ IndexMultiply()

void IndexMultiply ( Index out,
const Index in,
const Index value,
const Verbosity verbosity 
)

WORKSPACE METHOD: IndexMultiply.

Multiplies a Index and a value (out = in * value).

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

Author
Patrick Eriksson, Oliver Lemke
Parameters
[out]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 132 of file m_basic_types.cc.

Referenced by IndexMultiply_g().

◆ IndexStepDown()

void IndexStepDown ( Index out,
const Index in,
const Verbosity verbosity 
)

WORKSPACE METHOD: IndexStepDown.

Performas: out = in - 1

Input and output can be same variable.

Author
Patrick Eriksson
Parameters
[out]outGeneric output
[in]inGeneric Input

Definition at line 140 of file m_basic_types.cc.

Referenced by IndexStepDown_g().

◆ IndexStepUp()

void IndexStepUp ( Index out,
const Index in,
const Verbosity verbosity 
)

WORKSPACE METHOD: IndexStepUp.

Performas: out = in + 1

Input and output can be same variable.

Author
Patrick Eriksson
Parameters
[out]outGeneric output
[in]inGeneric Input

Definition at line 145 of file m_basic_types.cc.

Referenced by IndexStepUp_g().

◆ IndexSubtract()

void IndexSubtract ( Index out,
const Index in,
const Index value,
const Verbosity verbosity 
)

WORKSPACE METHOD: IndexSubtract.

Subtracts a Index value (out = in - value).

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

Author
Patrick Eriksson
Parameters
[out]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 150 of file m_basic_types.cc.

Referenced by IndexSubtract_g().

◆ Matrix1ColFromVector()

void Matrix1ColFromVector ( Matrix out,
const Vector v,
const Verbosity verbosity 
)

WORKSPACE METHOD: Matrix1ColFromVector.

Forms a matrix containing one column from a vector.

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

Definition at line 317 of file m_basic_types.cc.

References joker, Matrix::resize(), and v.

Referenced by Matrix1ColFromVector_g().

◆ Matrix1RowFromVector()

void Matrix1RowFromVector ( Matrix out,
const Vector v,
const Verbosity verbosity 
)

WORKSPACE METHOD: Matrix1RowFromVector.

Forms a matrix containing one row from a vector.

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

Definition at line 365 of file m_basic_types.cc.

References joker, Matrix::resize(), and v.

Referenced by Matrix1RowFromVector_g().

◆ Matrix2ColFromVectors()

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

Definition at line 329 of file m_basic_types.cc.

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

Referenced by Matrix2ColFromVectors_g().

◆ Matrix2RowFromVectors()

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

Definition at line 377 of file m_basic_types.cc.

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

Referenced by Matrix2RowFromVectors_g().

◆ Matrix3ColFromVectors()

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

Definition at line 346 of file m_basic_types.cc.

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

Referenced by Matrix3ColFromVectors_g().

◆ Matrix3RowFromVectors()

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

Definition at line 394 of file m_basic_types.cc.

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

Referenced by Matrix3RowFromVectors_g().

◆ MatrixAdd()

void MatrixAdd ( Matrix out,
const Matrix in,
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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 158 of file m_basic_types.cc.

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

Referenced by MatrixAdd_g().

◆ MatrixCopySparse()

void MatrixCopySparse ( Matrix out,
const Sparse in,
const Verbosity verbosity 
)

WORKSPACE METHOD: MatrixCopySparse.

Creates a matrix by copying a variable of type Sparse.

Author
Patrick Eriksson
Parameters
[out]outGeneric output
[in]inGeneric Input

Definition at line 230 of file m_basic_types.cc.

References c, Sparse::ncols(), Sparse::nrows(), and Matrix::resize().

Referenced by MatrixCopySparse_g().

◆ MatrixDivide()

void MatrixDivide ( Matrix out,
const Matrix in,
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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 176 of file m_basic_types.cc.

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

Referenced by MatrixDivide_g().

◆ MatrixExtractFromTensor3()

void MatrixExtractFromTensor3 ( Matrix out,
const Tensor3 in,
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]outGeneric output
[in]inGeneric Input
[in]iGeneric Input
[in]directionGeneric Input

Definition at line 241 of file m_basic_types.cc.

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

Referenced by MatrixExtractFromTensor3_g().

◆ MatrixIdentity()

void MatrixIdentity ( Matrix out,
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]outGeneric output
[in]nGeneric Input
[in]valueGeneric Input (Default: "1")

Definition at line 413 of file m_basic_types.cc.

References id_mat(), and Matrix::resize().

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 289 of file m_basic_types.cc.

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

Referenced by MatrixMatrixMultiply_g().

◆ MatrixMultiply()

void MatrixMultiply ( Matrix out,
const Matrix in,
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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 194 of file m_basic_types.cc.

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

Referenced by MatrixMultiply_g().

◆ MatrixSetConstant()

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

Definition at line 425 of file m_basic_types.cc.

References Matrix::resize().

Referenced by MatrixSetConstant_g().

◆ MatrixSubtract()

void MatrixSubtract ( Matrix out,
const Matrix in,
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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 212 of file m_basic_types.cc.

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

Referenced by MatrixSubtract_g().

◆ NumericAdd()

void NumericAdd ( Numeric out,
const Numeric in,
const Numeric value,
const Verbosity verbosity 
)

WORKSPACE METHOD: NumericAdd.

Adds a Numeric and a value (out = in + value).

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

Author
Patrick Eriksson
Parameters
[out]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 435 of file m_basic_types.cc.

Referenced by NumericAdd_g().

◆ NumericClip()

void NumericClip ( Numeric out,
const Numeric in,
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, out is set to limit_low. And the same is performed with respect to limit_high.

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

Definition at line 443 of file m_basic_types.cc.

Referenced by NumericClip_g().

◆ NumericDivide()

void NumericDivide ( Numeric out,
const Numeric in,
const Numeric value,
const Verbosity verbosity 
)

WORKSPACE METHOD: NumericDivide.

Divides a Numeric with a value (out = in / value).

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

Author
Jana Mendrok
Parameters
[out]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 457 of file m_basic_types.cc.

Referenced by NumericDivide_g().

◆ NumericFromVector()

void NumericFromVector ( Numeric out,
const Vector in,
const String op,
const Verbosity verbosity 
)

WORKSPACE METHOD: NumericFromVector.

Derivs a Numeric from a vector, following selected operation.

The following operations can be selected: <br> first : Selects the first element of the vector. <br> last : Selects the last element of the vector. <br> max : Selects the maximum element of the vector. <br> min : Selects the minimum element of the vector. <br> mean : Calculates the mean of the vector.

Author
Patrick Eriksson
Parameters
[out]outGeneric output
[in]inGeneric Input
[in]opGeneric Input

Definition at line 465 of file m_basic_types.cc.

References max(), mean(), min(), and ConstVectorView::nelem().

Referenced by NumericFromVector_g().

◆ NumericMultiply()

void NumericMultiply ( Numeric out,
const Numeric in,
const Numeric value,
const Verbosity verbosity 
)

WORKSPACE METHOD: NumericMultiply.

Multiplies a Numeric with a value (out = in*value).

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

Author
Patrick Eriksson
Parameters
[out]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 488 of file m_basic_types.cc.

Referenced by NumericMultiply_g().

◆ NumericSubtract()

void NumericSubtract ( Numeric out,
const Numeric in,
const Numeric value,
const Verbosity verbosity 
)

WORKSPACE METHOD: NumericSubtract.

Subtracts a Numeric value (out = in - value).

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

Author
Patrick Eriksson
Parameters
[out]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 496 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 3204 of file m_basic_types.cc.

Referenced by PrintPhysicalConstants_g().

◆ RationalAdd()

void RationalAdd ( Rational out,
const Rational in,
const Rational value,
const Verbosity verbosity 
)

WORKSPACE METHOD: RationalAdd.

Adds a Rational and a value (out = in + value).

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

Author
Richard Larsson
Parameters
[out]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 504 of file m_basic_types.cc.

Referenced by RationalAdd_g().

◆ RationalDivide()

void RationalDivide ( Rational out,
const Rational in,
const Rational value,
const Verbosity verbosity 
)

WORKSPACE METHOD: RationalDivide.

Divides a Rational with a value (out = in / value).

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

Author
Richard Larsson
Parameters
[out]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 512 of file m_basic_types.cc.

Referenced by RationalDivide_g().

◆ RationalMultiply()

void RationalMultiply ( Rational out,
const Rational in,
const Rational value,
const Verbosity verbosity 
)

WORKSPACE METHOD: RationalMultiply.

Multiplies a Rational with a value (out = in * value).

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

Author
Richard Larsson
Parameters
[out]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 520 of file m_basic_types.cc.

Referenced by RationalMultiply_g().

◆ RationalSubtract()

void RationalSubtract ( Rational out,
const Rational in,
const Rational value,
const Verbosity verbosity 
)

WORKSPACE METHOD: RationalSubtract.

Subtracts a Rational value (out = in - value).

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

Author
Richard Larsson
Parameters
[out]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 528 of file m_basic_types.cc.

Referenced by RationalSubtract_g().

◆ SparseIdentity()

void SparseIdentity ( Sparse out,
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]outGeneric output
[in]nGeneric Input
[in]valueGeneric Input (Default: "1")

Definition at line 562 of file m_basic_types.cc.

References id_mat(), and Sparse::resize().

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 537 of file m_basic_types.cc.

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

Referenced by SparseSparseMultiply_g().

◆ Tensor3Add()

void Tensor3Add ( Tensor3 out,
const Tensor3 in,
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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 598 of file m_basic_types.cc.

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

Referenced by Tensor3Add_g().

◆ Tensor3ExtractFromTensor4()

void Tensor3ExtractFromTensor4 ( Tensor3 out,
const Tensor4 in,
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]outGeneric output
[in]inGeneric Input
[in]iGeneric Input
[in]directionGeneric Input

Definition at line 665 of file m_basic_types.cc.

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

Referenced by Tensor3ExtractFromTensor4_g().

◆ Tensor3FromVector()

void Tensor3FromVector ( Tensor3 out,
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]outGeneric output
[in]vGeneric Input

Definition at line 616 of file m_basic_types.cc.

References joker, Tensor3::resize(), and v.

Referenced by Tensor3FromVector_g().

◆ Tensor3Multiply()

void Tensor3Multiply ( Tensor3 out,
const Tensor3 in,
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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 628 of file m_basic_types.cc.

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

Referenced by Tensor3Multiply_g().

◆ Tensor3SetConstant()

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

Definition at line 646 of file m_basic_types.cc.

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

Referenced by Tensor3SetConstant_g().

◆ Tensor4Add()

void Tensor4Add ( Tensor4 out,
const Tensor4 in,
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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 724 of file m_basic_types.cc.

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

Referenced by Tensor4Add_g().

◆ Tensor4Multiply()

void Tensor4Multiply ( Tensor4 out,
const Tensor4 in,
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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 742 of file m_basic_types.cc.

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

Referenced by Tensor4Multiply_g().

◆ Tensor4SetConstant()

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

Definition at line 760 of file m_basic_types.cc.

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

Referenced by Tensor4SetConstant_g().

◆ Tensor5Multiply()

void Tensor5Multiply ( Tensor5 out,
const Tensor5 in,
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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 781 of file m_basic_types.cc.

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

Referenced by Tensor5Multiply_g().

◆ Tensor5SetConstant()

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

Definition at line 799 of file m_basic_types.cc.

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

Referenced by Tensor5SetConstant_g().

◆ Tensor6Multiply()

void Tensor6Multiply ( Tensor6 out,
const Tensor6 in,
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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 822 of file m_basic_types.cc.

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

Referenced by Tensor6Multiply_g().

◆ Tensor6SetConstant()

void Tensor6SetConstant ( Tensor6 out,
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]outGeneric 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 845 of file m_basic_types.cc.

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

Referenced by Tensor6SetConstant_g().

◆ Tensor7Multiply()

void Tensor7Multiply ( Tensor7 out,
const Tensor7 in,
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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 870 of file m_basic_types.cc.

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

Referenced by Tensor7Multiply_g().

◆ Tensor7SetConstant()

void Tensor7SetConstant ( Tensor7 out,
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]outGeneric 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 894 of file m_basic_types.cc.

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

Referenced by Tensor7SetConstant_g().

◆ Trapz()

void Trapz ( Numeric out,
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]outGeneric output
[in]xGeneric Input
[in]yGeneric Input

Definition at line 921 of file m_basic_types.cc.

References ConstVectorView::nelem().

Referenced by Trapz_g().

◆ VectorAdd()

void VectorAdd ( Vector out,
const Vector in,
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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 936 of file m_basic_types.cc.

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

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 1008 of file m_basic_types.cc.

References a, b, and c.

Referenced by VectorAddElementwise_g().

◆ VectorClip()

void VectorClip ( Vector out,
const Vector in,
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 out 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]outGeneric output
[in]inGeneric Input
[in]limit_lowGeneric Input (Default: "-Inf")
[in]limit_highGeneric Input (Default: "Inf")

Definition at line 1152 of file m_basic_types.cc.

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

Referenced by VectorClip_g().

◆ VectorCrop()

void VectorCrop ( Vector out,
const Vector in,
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]outGeneric output
[in]inGeneric Input
[in]min_valueGeneric Input (Default: "-99e99")
[in]max_valueGeneric Input (Default: "99e99")

Definition at line 1172 of file m_basic_types.cc.

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

Referenced by VectorCrop_g().

◆ VectorDivide()

void VectorDivide ( Vector out,
const Vector in,
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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 954 of file m_basic_types.cc.

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

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 1116 of file m_basic_types.cc.

References a, b, and c.

Referenced by VectorDivideElementwise_g().

◆ VectorExtractFromMatrix()

void VectorExtractFromMatrix ( Vector out,
const Matrix in,
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]outGeneric output
[in]inGeneric Input
[in]iGeneric Input
[in]directionGeneric Input

Definition at line 1209 of file m_basic_types.cc.

References joker, ConstMatrixView::ncols(), ConstMatrixView::nrows(), and v.

Referenced by VectorExtractFromMatrix_g().

◆ VectorFlip()

void VectorFlip ( Vector out,
const Vector in,
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]outGeneric output
[in]inGeneric Input

Definition at line 1247 of file m_basic_types.cc.

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

Referenced by VectorFlip_g().

◆ VectorInsertGridPoints()

void VectorInsertGridPoints ( Vector out,
const Vector in,
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]outGeneric output
[in]inGeneric Input
[in]pointsGeneric Input

Definition at line 1263 of file m_basic_types.cc.

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

Referenced by VectorInsertGridPoints_g().

◆ VectorLinSpace()

void VectorLinSpace ( Vector out,
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]outGeneric output
[in]startGeneric Input
[in]stopGeneric Input
[in]stepGeneric Input

Definition at line 1367 of file m_basic_types.cc.

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

Referenced by VectorLinSpace_g().

◆ VectorLogSpace()

void VectorLogSpace ( Vector out,
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]outGeneric output
[in]startGeneric Input
[in]stopGeneric Input
[in]stepGeneric Input

Definition at line 1388 of file m_basic_types.cc.

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

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 1410 of file m_basic_types.cc.

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

Referenced by VectorMatrixMultiply_g().

◆ VectorMultiply()

void VectorMultiply ( Vector out,
const Vector in,
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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 972 of file m_basic_types.cc.

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

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 1080 of file m_basic_types.cc.

References a, b, and c.

Referenced by VectorMultiplyElementwise_g().

◆ VectorNLinSpace()

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

Definition at line 1462 of file m_basic_types.cc.

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

Referenced by test17(), test18(), test19(), test20(), test21(), test22(), test23(), test25(), test28(), VectorNLinSpace_g(), and VectorNLinSpaceConst().

◆ VectorNLogSpace()

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

Definition at line 1499 of file m_basic_types.cc.

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

◆ VectorPower()

void VectorPower ( Vector out,
const Vector in,
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]outGeneric output
[in]inGeneric Input
[in]powerGeneric Input

Definition at line 1522 of file m_basic_types.cc.

Referenced by VectorPower_g().

◆ VectorReshapeMatrix()

void VectorReshapeMatrix ( Vector out,
const Matrix in,
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 ouput vector has the same length for both options.

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

Definition at line 1539 of file m_basic_types.cc.

Referenced by VectorReshapeMatrix_g().

◆ VectorSetConstant()

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

Definition at line 1573 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 1436 of file m_basic_types.cc.

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

Referenced by VectorSparseMultiply_g().

◆ VectorSubtract()

void VectorSubtract ( Vector out,
const Vector in,
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]outGeneric output
[in]inGeneric Input
[in]valueGeneric Input

Definition at line 990 of file m_basic_types.cc.

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

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 1044 of file m_basic_types.cc.

References a, b, and c.

Referenced by VectorSubtractElementwise_g().