Various useful functions. More...

#include <vector>
#include <algorithm>
#include "universal_error.hpp"
#include <cassert>
#include "boost/container/flat_map.hpp"
#include <iostream>

Include dependency graph for utils.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	BinaryOperation< T >
	BinaryOperation Binary operator. More...

class	UnaryOperation< T >
	Abstract class for an unary operation. More...

Functions
bool	is_nan (double x)
	Checks whether a number is a nan. More...

vector< double >	linspace (double xl, double xh, int n)
	Uniformly spaced array (like the matlab function with the same name) More...

vector< double >	arange (double x_min, double x_max, double dx)
	Uniformly spaced array (line numpy function with the same name) More...

template<class T >
vector< T >	operator+ (vector< T > const &v1, vector< T > const &v2)
	Term by term addition for vectors. More...

template<class T >
vector< T >	operator+ (const vector< T > &v, const T &t)
	Adds the same thing to all terms in a vector. More...

template<class T >
vector< T >	operator+ (const T &t, const vector< T > &v)
	Adds the same thing to all terms in a vector. More...

template<class T >
vector< T > &	operator+= (vector< T > &v, const T &t)
	Adds the same thing to all terms in a vector. More...

template<class T >
vector< T >	operator- (vector< T > const &v1, vector< T > const &v2)
	Term by term vector subtraction. More...

template<class T >
vector< T >	operator* (double d, vector< T > const &v)
	Multiplies all terms of a vector by a scalar. More...

template<typename T >
T	BiLinearInterpolation (const vector< T > &x, const vector< T > &y, const std::vector< std::vector< T > > &z, T xi, T yi)
	BiLinear Interpolation. More...

template<typename T >
T	LinearInterpolation (const vector< T > &x, const vector< T > &y, T xi)
	Linear Interpolation. More...

template<typename T >
T	LinearInterpolation (typename vector< T >::const_iterator itx_begin, typename vector< T >::const_iterator itx_end, typename vector< T >::const_iterator ity_begin, T xi)
	Linear Interpolation. More...

double	min (vector< double > const &v)
	Returns the minimal term in a vector. More...

double	max (vector< double > const &v)
	returns the maximal term in a vector More...

template<class T >
void	RemoveVector (vector< T > &v, vector< int > &indeces)
	Removes the elements in v given by indeces. More...

template<class T >
void	RemoveVector (vector< T > &v, vector< size_t > &indeces)
	Removes the elements in v given by indeces. More...

template<class T >
vector< T >	VectorValues (vector< T > const &v, vector< int > const &index)
	Returns only the values with indeces in index. More...

template<class T >
vector< T >	VectorValues (vector< T > const &v, vector< size_t > const &index)
	Returns only the values with indeces in index. More...

template<class T >
T	VectorSum (vector< T > const &v)
	Returns the sum of the vector. More...

template<class T >
vector< T >	unique (vector< T > const &v)
	Returns a vector containing only unique elements. More...

template<class T >
vector< int >	unique_index (vector< T > const &v)
	Returns a vector containing only indeces of unique elements. More...

template<class T >
vector< T >	RemoveList (vector< T > const &v, vector< T > const &list)
	Returns only elements from vector v which are not in vector list, assumes list is sorted. More...

template<class T >
void	RemoveVal (vector< T > &vec, T val)
	Removes the first occurence of val inside a vector. More...

template<class T >
bool	InVector (vector< T > const &vec, T val)
	checks if val is in the vector More...

template<class T >
int	IndexInVector (vector< T > const &vec, T val)
	Returns the index of val in the vector. More...

template<class T >
void	ReArrangeVector (vector< T > &v, vector< int > const &indeces)
	Rearranges the vector according to the indeces. More...

template<class T >
void	sort_index (const vector< T > &arr, vector< int > &res)
	Returns the indeces of a sort. More...

template<class T >
void	sort_index (const vector< T > &arr, vector< size_t > &res)
	Returns the indeces of a sort. More...

template<class T >
vector< size_t >	sort_index (const vector< T > &arr)
	Returns the indeces of a sort. More...

template<class RAIter , class Compare >
void	sort_index (RAIter iterBegin, RAIter iterEnd, Compare comp, std::vector< size_t > &indexes)
	Returns the indeces of a sort. More...

template<class T >
vector< T >	join (vector< T > const &v1, vector< T > const &v2)
	Concatenates two vectors. More...

template<class T >
vector< T >	binary_unite (vector< T > const &v1, vector< T > const &v2, BinaryOperation< T > const &bin_op)
	Applies a binary operation on every pair of values from two vectors. More...

template<class T >
vector< T >	apply_to_each_term (vector< T > const &v, UnaryOperation< T > const &un_op)
	Applies an unary operator to all terms in a std::vector. More...

template<class T >
T	pair_member (const std::pair< T, T > &p, int index)
	Selects a member of std::pair. More...

template<class T >
void	set_pair_member (std::pair< T, T > &p, int index, const T &val)
	Sets a member of std::pair. More...

template<class T , class S >
vector< T >	list_static_cast (const vector< S > &source)
	Performs type casting for an entire vector. More...

template<class T >
void	insert_all_to_back (vector< T > &subject, const vector< T > &addendum)
	Inserts all elements from one vector to the end of another. More...

template<class Iter , class T >
Iter	binary_find (Iter begin, Iter end, T val)
	Binary search that return iterator of found object or end if not found. More...

template<class S , class T >
vector< T >::const_reference	safe_retrieve (vector< T > const &data, vector< S > const &keys, const S &key)
	Checks for existence and retrieves entry from flat map. More...

template<class S , class T >
vector< T >::reference	safe_retrieve (vector< T > &data, vector< S > const &keys, const S &key)
	Checks for existence and retrieves entry from flat map. More...

template<class S , class T >
const T &	safe_retrieve (const boost::container::flat_map< S, T > &m, const S &s)
	Checks for existence and retrieves entry from flat map. More...

template<class T >
vector< vector< T > >	CombineVectors (vector< vector< vector< T > > > const &data)
	Reduces the dimension of the input vector. More...

template<class T >
vector< T >	CombineVectors (vector< vector< T > > const &data)
	Reduces the dimension of the input vector. More...

template<class S , class T >
T &	safe_retrieve (boost::container::flat_map< S, T > &m, const S &s)
	Non constant version of safe retrieve. More...

double	fastsqrt (double x)
	Fast approximate sqrt. More...

Detailed Description

Various useful functions.

Author: Almog Yalinewich

Definition in file utils.hpp.

Function Documentation

◆ apply_to_each_term()

template<class T >

vector<T> apply_to_each_term	(	vector< T > const &	v,
		UnaryOperation< T > const &	un_op
	)

Applies an unary operator to all terms in a std::vector.

Parameters

v	Vector
un_op	Unary operator

Returns: Vector

Definition at line 646 of file utils.hpp.

◆ arange()

vector<double> arange	(	double	x_min,
		double	x_max,
		double	dx
	)

Uniformly spaced array (line numpy function with the same name)

Parameters

x_min	Lower bound
x_max	Upper bound
dx	Difference between consecutive terms

Returns: Uniformly spaced array

Definition at line 35 of file utils.cpp.

◆ BiLinearInterpolation()

template<typename T >

T BiLinearInterpolation	(	const vector< T > &	x,
		const vector< T > &	y,
		const std::vector< std::vector< T > > &	z,
		T	xi,
		T	yi
	)

BiLinear Interpolation.

Parameters

x	The x vector, assumed sorted
y	The y vector, assumed sorted
z	z=f(x,y) matrix, first index is in x
xi	The x interpolation location
yi	The y interpolation location

Returns: f(xi)

Definition at line 137 of file utils.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ binary_find()

template<class Iter , class T >

Iter binary_find	(	Iter	begin,
		Iter	end,
		T	val
	)

Binary search that return iterator of found object or end if not found.

Parameters

begin	begin iterator
end	end iterator
val	The value to search for

Returns: iterator of found object or end if not found

Definition at line 709 of file utils.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ binary_unite()

template<class T >

vector<T> binary_unite	(	vector< T > const &	v1,
		vector< T > const &	v2,
		BinaryOperation< T > const &	bin_op
	)

Applies a binary operation on every pair of values from two vectors.

Parameters

v1	First vector
v2	Second vector
bin_op	Binary operation

Returns: Vector

Definition at line 615 of file utils.hpp.

◆ CombineVectors() [1/2]

template<class T >

vector<vector<T> > CombineVectors ( vector< vector< vector< T > > > const & data )

Reduces the dimension of the input vector.

Parameters

data	The vector to reduce its dimension

Returns: The reduced vector

Definition at line 770 of file utils.hpp.

Here is the caller graph for this function:

◆ CombineVectors() [2/2]

template<class T >

vector<T> CombineVectors ( vector< vector< T > > const & data )

Reduces the dimension of the input vector.

Parameters

data	The vector to reduce its dimension

Returns: The reduced vector

Definition at line 794 of file utils.hpp.

Here is the call graph for this function:

◆ fastsqrt()

double fastsqrt ( double x )

Fast approximate sqrt.

Parameters

x	The value to calculate the sqrt of

Returns: Sqrt(x)

Definition at line 11 of file utils.cpp.

Here is the caller graph for this function:

◆ IndexInVector()

template<class T >

int IndexInVector	(	vector< T > const &	vec,
		T	val
	)

Returns the index of val in the vector.

Parameters

vec	The vector to check
val	The value to look for

Returns: The index of the vector which first equals to val, throws exception if not found

Definition at line 464 of file utils.hpp.

◆ insert_all_to_back()

template<class T >

void insert_all_to_back	(	vector< T > &	subject,
		const vector< T > &	addendum
	)

Inserts all elements from one vector to the end of another.

Parameters

subject	Vector that will be modifies
addendum	Vector that will be added

Definition at line 696 of file utils.hpp.

◆ InVector()

template<class T >

bool InVector	(	vector< T > const &	vec,
		T	val
	)

checks if val is in the vector

Parameters

vec	The vector to check
val	The value to check inside the vector

Returns: True if the value is in the vector, false otherwise

Definition at line 449 of file utils.hpp.

◆ is_nan()

bool is_nan ( double x )

Checks whether a number is a nan.

Parameters

x A number

Returns: True if nan false otherwise

Definition at line 19 of file utils.cpp.

Here is the caller graph for this function:

◆ join()

template<class T >

vector<T> join	(	vector< T > const &	v1,
		vector< T > const &	v2
	)

Concatenates two vectors.

Parameters

v1	vector
v2	vector

Returns: vector

Definition at line 581 of file utils.hpp.

◆ LinearInterpolation() [1/2]

template<typename T >

T LinearInterpolation	(	const vector< T > &	x,
		const vector< T > &	y,
		T	xi
	)

Linear Interpolation.

Parameters

x	The x vector, assumed sorted
y	y=f(x) vector
xi	The interpolation location

Returns: f(xi)

Definition at line 197 of file utils.hpp.

Here is the caller graph for this function:

◆ LinearInterpolation() [2/2]

template<typename T >

T LinearInterpolation	(	typename vector< T >::const_iterator	itx_begin,
		typename vector< T >::const_iterator	itx_end,
		typename vector< T >::const_iterator	ity_begin,
		T	xi
	)

Linear Interpolation.

Parameters

itx_begin	The iterator to the beginining of the X sequence, assumed sorted
itx_end	The iterator to the end of the X sequence
ity_begin	The iterator to the beginining of the Y sequence, assumed sorted
xi	The interpolation location

Returns: y(xi)

Definition at line 233 of file utils.hpp.

Here is the call graph for this function:

◆ linspace()

vector<double> linspace	(	double	xl,
		double	xh,
		int	n
	)

Uniformly spaced array (like the matlab function with the same name)

Parameters

xl	Lower bound
xh	Higher bound
n	Number of elements

Returns: The uniformly spaced array

Definition at line 26 of file utils.cpp.

◆ list_static_cast()

template<class T , class S >

vector<T> list_static_cast ( const vector< S > & source )

Performs type casting for an entire vector.

Parameters

source Source vector

Returns: Source vector converted to new type

Definition at line 684 of file utils.hpp.

◆ max()

double max ( vector< double > const & v )

returns the maximal term in a vector

Parameters

v Vector

Returns: The maximum of the vector

Definition at line 52 of file utils.cpp.

Here is the caller graph for this function:

◆ min()

double min ( vector< double > const & v )

Returns the minimal term in a vector.

Parameters

v Vector

Returns: The minimum of the vector

Definition at line 44 of file utils.cpp.

Here is the caller graph for this function:

◆ operator*()

template<class T >

vector<T> operator*	(	double	d,
		vector< T > const &	v
	)

Multiplies all terms of a vector by a scalar.

Parameters

d	Scalar
v	vector

Returns: The mulitplication of the vector

Definition at line 116 of file utils.hpp.

Here is the call graph for this function:

◆ operator+() [1/3]

template<class T >

vector<T> operator+	(	vector< T > const &	v1,
		vector< T > const &	v2
	)

Term by term addition for vectors.

Parameters

v1	Right argument
v2	Left argument

Returns: The addition of the two vectors

Definition at line 46 of file utils.hpp.

◆ operator+() [2/3]

template<class T >

vector<T> operator+	(	const vector< T > &	v,
		const T &	t
	)

Adds the same thing to all terms in a vector.

Parameters

v	Vector
t	Addition

Returns: New vector with sums as terms

Definition at line 61 of file utils.hpp.

◆ operator+() [3/3]

template<class T >

vector<T> operator+	(	const T &	t,
		const vector< T > &	v
	)

Adds the same thing to all terms in a vector.

Parameters

v	Vector
t	Addition

Returns: New vector with sums as terms

Definition at line 75 of file utils.hpp.

◆ operator+=()

template<class T >

vector<T>& operator+=	(	vector< T > &	v,
		const T &	t
	)

Adds the same thing to all terms in a vector.

Parameters

v	Vector
t	Addition

Returns: Reference to united vector

Definition at line 86 of file utils.hpp.

◆ operator-()

template<class T >

vector<T> operator-	(	vector< T > const &	v1,
		vector< T > const &	v2
	)

Term by term vector subtraction.

Parameters

v1	Left argument
v2	Right argument

Returns: The subtraction between the vectors

Definition at line 99 of file utils.hpp.

◆ pair_member()

template<class T >

T pair_member	(	const std::pair< T, T > &	p,
		int	index
	)

Selects a member of std::pair.

Parameters

p	A pair
index	0 for first member, 1 for second, error otherwise

Returns: Either first or second members of pair

Definition at line 660 of file utils.hpp.

Here is the caller graph for this function:

◆ ReArrangeVector()

template<class T >

void ReArrangeVector	(	vector< T > &	v,
		vector< int > const &	indeces
	)

Rearranges the vector according to the indeces.

Parameters

v	The vector to rearrange
indeces	The rearrangement indeces

Definition at line 477 of file utils.hpp.

◆ RemoveList()

template<class T >

vector<T> RemoveList	(	vector< T > const &	v,
		vector< T > const &	list
	)

Returns only elements from vector v which are not in vector list, assumes list is sorted.

Parameters

v	The vector to change
list	The values to be taken out of v

Returns: The new vector

Definition at line 416 of file utils.hpp.

Here is the caller graph for this function:

◆ RemoveVal()

template<class T >

void RemoveVal	(	vector< T > &	vec,
		T	val
	)

Removes the first occurence of val inside a vector.

Parameters

vec	The vector to change
val	The value to remove

Definition at line 431 of file utils.hpp.

Here is the caller graph for this function:

◆ RemoveVector() [1/2]

template<class T >

void RemoveVector	(	vector< T > &	v,
		vector< int > &	indeces
	)

Removes the elements in v given by indeces.

Parameters

v	The vector to change
indeces	The cells to remove

Definition at line 275 of file utils.hpp.

Here is the caller graph for this function:

◆ RemoveVector() [2/2]

template<class T >

void RemoveVector	(	vector< T > &	v,
		vector< size_t > &	indeces
	)

Removes the elements in v given by indeces.

Parameters

v	The vector to change
indeces	The cells to remove

Definition at line 301 of file utils.hpp.

◆ safe_retrieve() [1/4]

template<class S , class T >

vector<T>::const_reference safe_retrieve	(	vector< T > const &	data,
		vector< S > const &	keys,
		const S &	key
	)

Checks for existence and retrieves entry from flat map.

Parameters

data	Data vector
key	Key to look for
keys	Sorted vector of keys

Returns: Value corresponding to key

Definition at line 727 of file utils.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ safe_retrieve() [2/4]

template<class S , class T >

vector<T>::reference safe_retrieve	(	vector< T > &	data,
		vector< S > const &	keys,
		const S &	key
	)

Checks for existence and retrieves entry from flat map.

Parameters

data	Data vector
key	Key to look for
keys	Sorted vector of keys

Returns: Value corresponding to key

Definition at line 743 of file utils.hpp.

Here is the call graph for this function:

◆ safe_retrieve() [3/4]

template<class S , class T >

const T& safe_retrieve	(	const boost::container::flat_map< S, T > &	m,
		const S &	s
	)

Checks for existence and retrieves entry from flat map.

Parameters

m	flat map
s	Key

Returns: Value corresponding to key

Definition at line 757 of file utils.hpp.

◆ safe_retrieve() [4/4]

template<class S , class T >

T& safe_retrieve	(	boost::container::flat_map< S, T > &	m,
		const S &	s
	)

Non constant version of safe retrieve.

Parameters

m	flat map
s	Key

Returns: Value corresponding to key

Definition at line 808 of file utils.hpp.

Here is the call graph for this function:

◆ set_pair_member()

template<class T >

void set_pair_member	(	std::pair< T, T > &	p,
		int	index,
		const T &	val
	)

Sets a member of std::pair.

Parameters

p	Pair
index	0 for first, 1 for second, error otherwise
val	Value to be written

Definition at line 671 of file utils.hpp.

◆ sort_index() [1/4]

template<class T >

void sort_index	(	const vector< T > &	arr,
		vector< int > &	res
	)

Returns the indeces of a sort.

Parameters

arr	The array to sort
res	The indeces of the sort that is given as the output

Definition at line 500 of file utils.hpp.

Here is the caller graph for this function:

◆ sort_index() [2/4]

template<class T >

void sort_index	(	const vector< T > &	arr,
		vector< size_t > &	res
	)

Returns the indeces of a sort.

Parameters

arr	The array to sort
res	The indeces of the sort that is given as the output

Definition at line 512 of file utils.hpp.

◆ sort_index() [3/4]

template<class T >

vector<size_t> sort_index ( const vector< T > & arr )

Returns the indeces of a sort.

Parameters

arr	The array to sort

Returns: The indeces of the sort that is given as the output

Definition at line 525 of file utils.hpp.

◆ sort_index() [4/4]

template<class RAIter , class Compare >

void sort_index	(	RAIter	iterBegin,
		RAIter	iterEnd,
		Compare	comp,
		std::vector< size_t > &	indexes
	)

Returns the indeces of a sort.

Parameters

iterBegin	Starting iterator
iterEnd	End iterator
comp	The compare function
indexes	Output

Definition at line 556 of file utils.hpp.

◆ unique()

template<class T >

vector<T> unique ( vector< T > const & v )

Returns a vector containing only unique elements.

Parameters

v	The input vector, must be SORTED!!

Returns: The unique vector

Definition at line 376 of file utils.hpp.

Here is the caller graph for this function:

◆ unique_index()

template<class T >

vector<int> unique_index ( vector< T > const & v )

Returns a vector containing only indeces of unique elements.

Parameters

v	The input vector, must be SORTED!!

Returns: The unique vector indeces

Definition at line 397 of file utils.hpp.

Here is the caller graph for this function:

◆ VectorSum()

template<class T >

T VectorSum ( vector< T > const & v )

Returns the sum of the vector.

Parameters

v	The vector to sum

Returns: The sum

Definition at line 361 of file utils.hpp.

◆ VectorValues() [1/2]

template<class T >

vector<T> VectorValues	(	vector< T > const &	v,
		vector< int > const &	index
	)

Returns only the values with indeces in index.

Parameters

v	The vector to check
index	The indeces to return

Returns: The reduced vector

Definition at line 326 of file utils.hpp.

Here is the caller graph for this function:

◆ VectorValues() [2/2]

template<class T >

vector<T> VectorValues	(	vector< T > const &	v,
		vector< size_t > const &	index
	)

Returns only the values with indeces in index.

Parameters

v	The vector to check
index	The indeces to return

Returns: The reduced vector

Definition at line 344 of file utils.hpp.

Classes

Functions

Detailed Description

Function Documentation

◆ apply_to_each_term()

◆ arange()

◆ BiLinearInterpolation()

◆ binary_find()

◆ binary_unite()

◆ CombineVectors() [1/2]

◆ CombineVectors() [2/2]

◆ fastsqrt()

◆ IndexInVector()

◆ insert_all_to_back()

◆ InVector()

◆ is_nan()

◆ join()

◆ LinearInterpolation() [1/2]

◆ LinearInterpolation() [2/2]

◆ linspace()

◆ list_static_cast()

◆ max()

◆ min()

◆ operator*()

◆ operator+() [1/3]

◆ operator+() [2/3]

◆ operator+() [3/3]

◆ operator+=()

◆ operator-()

◆ pair_member()

◆ ReArrangeVector()

◆ RemoveList()

◆ RemoveVal()

◆ RemoveVector() [1/2]

◆ RemoveVector() [2/2]

◆ safe_retrieve() [1/4]

◆ safe_retrieve() [2/4]

◆ safe_retrieve() [3/4]

◆ safe_retrieve() [4/4]

◆ set_pair_member()

◆ sort_index() [1/4]

◆ sort_index() [2/4]

◆ sort_index() [3/4]

◆ sort_index() [4/4]

◆ unique()

◆ unique_index()

◆ VectorSum()

◆ VectorValues() [1/2]

◆ VectorValues() [2/2]