Logical functions. More...

#include <cmath>
#include <algorithm>
#include <stdexcept>
#include "logic.h"
#include "sorting.h"

Macros
#define	precision 0.

Functions
bool	is_bool (const Index &x)
	Checks if a variable equals 0 or 1. More...

bool	is_multiple (const Index &x, const Index &y)
	Checks if an integer is a multiple of another integer. More...

bool	is_size (ConstVectorView x, const Index &n)
	Verifies that the size of x is l. More...

bool	is_size (ConstMatrixView x, const Index &r, const Index &c)
	Verifies that the size of x is r by c. More...

bool	is_size (ConstTensor3View x, const Index &p, const Index &r, const Index &c)
	Verifies that the size of x is [p,r,c]. More...

bool	is_size (ConstTensor4View x, const Index &b, const Index &p, const Index &r, const Index &c)
	Verifies that the size of x is [b,p,r,c]. More...

bool	is_size (ConstTensor5View x, const Index &s, const Index &b, const Index &p, const Index &r, const Index &c)
	Verifies that the size of x is [s,b,p,r,c]. More...

bool	is_size (ConstTensor6View x, const Index &v, const Index &s, const Index &b, const Index &p, const Index &r, const Index &c)
	Verifies that the size of x is [v,s,b,p,r,c]. More...

bool	is_size (ConstTensor7View x, const Index &l, const Index &v, const Index &s, const Index &b, const Index &p, const Index &r, const Index &c)
	Verifies that the size of x is [l,v,s,b,p,r,c]. More...

bool	is_sorted (ConstVectorView x)
	Checks if a vector is sorted in ascending order. More...

bool	is_increasing (ConstVectorView x)
	Checks if a vector is sorted and strictly increasing. More...

bool	is_increasing (const ArrayOfIndex &x)
	Checks if an ArrayOfIndex is sorted and strictly increasing. More...

bool	is_decreasing (ConstVectorView x)
	Checks if a vector is sorted in reversed order and is strictly decreasing. More...

bool	is_unique (const ArrayOfIndex &x)
	Checks if an ArrayOfIndex is unique, i.e., has no duplicate values. More...

bool	is_singular (ConstMatrixView A)
	Checks if a square matrix is singular. More...

bool	is_diagonal (ConstMatrixView A)
	Checks if a square matrix is diagonal. More...

bool	is_same_within_epsilon (const Numeric &a, const Numeric &b, const Numeric &epsilon)
	Check, if two numbers agree within a given epsilon. More...

Detailed Description

Logical functions.

Author: Stefan Buehler sbueh.nosp@m.ler@.nosp@m.ltu.s.nosp@m.e

Date: Fri May 3 19:02:36 2002

All functions here have return type bool. They all check whether some condition is fullfilled and return true if that is the case.

These functions are intended to be used either inside "if" statements or inside "assert" statements.

The condition should have a simple and intuitive meaning!

Definition in file logic.cc.

Macro Definition Documentation

◆ precision

#define precision 0.

Definition at line 45 of file logic.cc.

Function Documentation

◆ is_bool()

bool is_bool ( const Index & x )

Checks if a variable equals 0 or 1.

Returns: True if the variable is 0 or 1. Otherwise false.

Parameters

x	A variable of type Index.

Definition at line 53 of file logic.cc.

Referenced by chk_if_bool().

◆ is_decreasing()

bool is_decreasing ( ConstVectorView x )

Checks if a vector is sorted in reversed order and is strictly decreasing.

Duplicated values are not allowed.

Returns: True if strictly decreasing, otherwise false.

Parameters

x A vector.

Definition at line 303 of file logic.cc.

References ConstVectorView::nelem().

Referenced by check_retrieval_grids(), chk_if_decreasing(), chk_interpolation_grids(), get_perturbation_limit(), gridpos(), sensor_integration_vector(), sensor_responseInit(), and VectorInsertGridPoints().

◆ is_diagonal()

bool is_diagonal ( ConstMatrixView A )

Checks if a square matrix is diagonal.

If one off diagonal element is nonzero the function returns false.

Due to numerical inaccuracies the values can deviate from 0. The value for the precision is defined in the file logic.cc.

Returns: True if matrix is diagonal.

Parameters

A	A square matrix.

Definition at line 387 of file logic.cc.

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

Referenced by ext2trans(), interpTArray(), mcPathTraceGeneral(), mcPathTraceIPA(), and rte_step_std().

◆ is_increasing() [1/2]

bool is_increasing ( const ArrayOfIndex & x )

Checks if an ArrayOfIndex is sorted and strictly increasing.

Duplicated values are not allowed. Clone of the similar funciton for vectors.

Returns: True if strictly increasing, otherwise false.

Parameters

x	An ArrayOfIndex.

Author: Stefan Buehler

Date: 2007-05-18

Definition at line 283 of file logic.cc.

References Array< base >::nelem().

◆ is_increasing() [2/2]

bool is_increasing ( ConstVectorView x )

Checks if a vector is sorted and strictly increasing.

Duplicated values are not allowed.

Returns: True if strictly increasing, otherwise false.

Parameters

x A vector.

Definition at line 258 of file logic.cc.

References ConstVectorView::nelem().

Referenced by check_retrieval_grids(), chk_if_increasing(), chk_interpolation_grids(), find_effective_channel_boundaries(), gridpos(), sensor_integration_vector(), sensor_responseBackend(), sensor_responseInit(), sensor_responseMixer(), and VectorInsertGridPoints().

◆ is_multiple()

bool is_multiple	(	const Index &	x,
		const Index &	y
	)

Checks if an integer is a multiple of another integer.

The function returns true if y * n = x, where n is an integer.

The choice of y = 0 is not allowed.

Returns: True if x is a multiple of y.

Parameters

x	Nominator of the integer division.
y	Denominator of the integer division.

Author: Patrick Eriksson

Date: 2002-08-11

Definition at line 73 of file logic.cc.

Referenced by integer_div(), and sensor_responseFrequencySwitching().

◆ is_same_within_epsilon()

bool is_same_within_epsilon	(	const Numeric &	a,
		const Numeric &	b,
		const Numeric &	epsilon
	)

Check, if two numbers agree within a given epsilon.

This logical function verifies if two numbers are the same for the desired number of digits. The comparison statement comes from Oliver: ( abs(a-b) <= epsilon * max(a,b) )

I only modified it to make sure that the right side also is positive. (Both a and b could be negative.)

The variable epsilon gives the number of digits used for the comparison. (epsilon = 0.0001 for a comparison up to the 5th digit)

Parameters

a	A number.
b	Another number.
epsilon	The epsilon of the required agreement.

Returns: True if the two numbers are the same.

Definition at line 421 of file logic.cc.

References abs, and max.

Referenced by interp().

◆ is_singular()

bool is_singular ( ConstMatrixView A )

Checks if a square matrix is singular.

If one row of a matrix has only 0 values the matrix is singular.

Due to numerical inaccuracies the values can deviate from 0. The value for the precision is defined in the file logic.cc.

Returns: True if matrix is singular.

Parameters

A	A square matrix.

Definition at line 353 of file logic.cc.

References ConstMatrixView::ncols(), ConstMatrixView::nrows(), precision, and temp.

Referenced by cloud_ppath_update1D_planeparallel(), cloud_RT_no_background(), ext2trans(), and rte_step_std().

◆ is_size() [1/7]

bool is_size	(	ConstMatrixView	x,
		const Index &	r,
		const Index &	c
	)

Verifies that the size of x is r by c.

Parameters

x	The Matrix to check.
r	The desired number of rows.
c	The desired number of columns.

Returns: True if the size of x is r x c.

Definition at line 103 of file logic.cc.

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

◆ is_size() [2/7]

bool is_size	(	ConstTensor3View	x,
		const Index &	p,
		const Index &	r,
		const Index &	c
	)

Verifies that the size of x is [p,r,c].

Parameters

x	The Tensor to check.
p	The desired number of pages.
r	The desired number of rows.
c	The desired number of columns.

Returns: True if the size of x is correct.

Definition at line 119 of file logic.cc.

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

◆ is_size() [3/7]

bool is_size	(	ConstTensor4View	x,
		const Index &	b,
		const Index &	p,
		const Index &	r,
		const Index &	c
	)

Verifies that the size of x is [b,p,r,c].

Parameters

x	The Tensor to check.
b	The desired number of books.
p	The desired number of pages.
r	The desired number of rows.
c	The desired number of columns.

Returns: True if the size of x is correct.

Definition at line 138 of file logic.cc.

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

◆ is_size() [4/7]

bool is_size	(	ConstTensor5View	x,
		const Index &	s,
		const Index &	b,
		const Index &	p,
		const Index &	r,
		const Index &	c
	)

Verifies that the size of x is [s,b,p,r,c].

Parameters

x	The Tensor to check.
s	The desired number of shelves.
b	The desired number of books.
p	The desired number of pages.
r	The desired number of rows.
c	The desired number of columns.

Returns: True if the size of x is correct.

Definition at line 160 of file logic.cc.

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

◆ is_size() [5/7]

bool is_size	(	ConstTensor6View	x,
		const Index &	v,
		const Index &	s,
		const Index &	b,
		const Index &	p,
		const Index &	r,
		const Index &	c
	)

Verifies that the size of x is [v,s,b,p,r,c].

Parameters

x	The Tensor to check.
v	The desired number of vitrines.
s	The desired number of shelves.
b	The desired number of books.
p	The desired number of pages.
r	The desired number of rows.
c	The desired number of columns.

Returns: True if the size of x is correct.

Definition at line 185 of file logic.cc.

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

◆ is_size() [6/7]

bool is_size	(	ConstTensor7View	x,
		const Index &	l,
		const Index &	v,
		const Index &	s,
		const Index &	b,
		const Index &	p,
		const Index &	r,
		const Index &	c
	)

Verifies that the size of x is [l,v,s,b,p,r,c].

Parameters

x	The Tensor to check.
l	The desired number of libraries.
v	The desired number of vitrines.
s	The desired number of shelves.
b	The desired number of books.
p	The desired number of pages.
r	The desired number of rows.
c	The desired number of columns.

Returns: True if the size of x is correct.

Definition at line 213 of file logic.cc.

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

◆ is_size() [7/7]

bool is_size	(	ConstVectorView	x,
		const Index &	n
	)

Verifies that the size of x is l.

This function is supposed to be used together with assert like this: assert(is_size(x,l))

Parameters

x	The Vector to check.
n	The desired length.

Returns: True if the size of x is l.

Definition at line 90 of file logic.cc.

References ConstVectorView::nelem().

Referenced by AngIntegrate_trapezoid(), AngIntegrate_trapezoid_fixedstep(), AngIntegrate_trapezoid_fixedstep_opt(), AngIntegrate_trapezoid_fixedstep_opt2(), AngIntegrate_trapezoid_opt(), AngIntegrate_trapezoid_opti(), AngIntegrate_trapezoid_original(), chk_size(), doit_conv_flagAbs(), doit_conv_flagAbsBT(), doit_conv_flagLsq(), doit_i_fieldSetConst(), doit_i_fieldUpdate1D(), doit_i_fieldUpdateSeq1D(), doit_i_fieldUpdateSeq1DPP(), doit_i_fieldUpdateSeq3D(), doit_scat_fieldCalc(), doit_scat_fieldCalcLimb(), DoitCloudboxFieldPut(), ext2trans(), GasAbsLookup::Extract(), gridpos(), gridpos_poly(), interp(), interpweights(), iy_interp_cloudbox_field(), lubacksub(), ludcmp(), matrix_exp(), and rte_step_std().

◆ is_sorted()

bool is_sorted ( ConstVectorView x )

Checks if a vector is sorted in ascending order.

Duplicated values are allowed.

Parameters

x A vector.

Returns: True if sorted.

Definition at line 238 of file logic.cc.

References ConstVectorView::nelem().

Referenced by xsec_species().

◆ is_unique()

bool is_unique ( const ArrayOfIndex & x )

Checks if an ArrayOfIndex is unique, i.e., has no duplicate values.

This only returns true if the array does not contain any duplicate values.

Returns: True if unique, otherwise false.

Parameters

x	An ArrayOfIndex.

Author: Stefan Buehler

Date: 2008-08-24

Definition at line 330 of file logic.cc.

References Array< base >::nelem().

Referenced by GasAbsLookup::Adapt().

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ precision

Function Documentation

◆ is_bool()

◆ is_decreasing()

◆ is_diagonal()

◆ is_increasing() [1/2]

◆ is_increasing() [2/2]

◆ is_multiple()

◆ is_same_within_epsilon()

◆ is_singular()

◆ is_size() [1/7]

◆ is_size() [2/7]

◆ is_size() [3/7]

◆ is_size() [4/7]

◆ is_size() [5/7]

◆ is_size() [6/7]

◆ is_size() [7/7]

◆ is_sorted()

◆ is_unique()