Provides fast methods to add/subtract list of data, to find maximum/minimum from list of data. More...

Functions
template<typename T >
size_t	maxIndex (const std::vector< T > &data)
	Returns the index corresponding to maximum from list of data.

template<typename T >
size_t	minIndex (const std::vector< T > &data)
	Returns the index corresponding to minimum from list of data.

template<typename T >
T	max (const std::vector< T > &data)
	Returns the maximum from list of data.

template<typename T >
T	min (const std::vector< T > &data)
	Returns the minimim from list of data.

template<typename T >
std::pair< size_t, T >	maxAndMaxIndex (const std::vector< T > &data)
	Returns the maximum and index of maximum from list of data.

template<typename T >
std::pair< size_t, T >	minAndMinIndex (const std::vector< T > &data)
	Returns the minimum and index of minimum from list of data.

template<typename T >
size_t	maxIndex (const std::vector< T > &data, size_t data_start, size_t data_end)
	Returns the index corresponding to maximum from list of data.

size_t	maxLengthIndex (const std::vector< util::Point > &data)
	Returns the index that has maximum length of point from list of points.

size_t	minLengthIndex (const std::vector< util::Point > &data)
	Returns the index that has minimum length of point from list of points.

double	maxLength (const std::vector< util::Point > &data)
	Returns the maximum length of point from list of points.

double	minLength (const std::vector< util::Point > &data)
	Returns the minimum length of point from list of points.

std::pair< double, size_t >	maxLengthAndMaxLengthIndex (const std::vector< util::Point > &data)
	Returns the maximum length of point and index from list of points.

std::pair< double, size_t >	minLengthAndMinLengthIndex (const std::vector< util::Point > &data)
	Returns the minimum length of point and index from list of points.

template<typename T >
T	add (const std::vector< T > &data)
	Returns the sum of data.

bool	isFree (const int &i, const unsigned int &dof)
	Returns true if degree of freedom is free.

bool	isFree (const uint8_t &i, const unsigned int &dof)
	Returns true if degree of freedom is free.

template<typename T >
bool	isInList (const T &i, const std::vector< T > &list)
	Find if data is in the list.

bool	isTagInList (const std::string &tag, const std::vector< std::string > &tags)
	Returns true if tag is found in the list of tags.

template<typename T >
void	addToList (const T &i, std::vector< T > &list)
	Add element to the list.

float	timeDiff (std::chrono::steady_clock::time_point begin, std::chrono::steady_clock::time_point end, std::string unit="microseconds")
	Returns difference between two times.

template<typename T_out >
T_out	getKeyData (std::string key, std::map< std::string, T_out > &data_map, bool issue_err=false)
	Get data for a key.

template<typename T_out >
void	appendKeyData (std::string key, T_out data, std::map< std::string, T_out > &data_map, bool issue_err=false)
	Append value to data associated with key.

template<typename T_out >
void	setKeyData (std::string key, T_out data, std::map< std::string, T_out > &data_map, bool issue_err=false)
	Set value to data associated with key.

template<class T >
T	l2Dist (const std::vector< T > &x1, const std::vector< T > &x2)
	Computes l2 distance between two vectors.

Detailed Description

Provides fast methods to add/subtract list of data, to find maximum/minimum from list of data.

Function Documentation

◆ add()

template<typename T >

T util::methods::add ( const std::vector< T > & data )

inline

Returns the sum of data.

Parameters

data	List of real numbers

Returns: value Sum of the numbers

Definition at line 243 of file vecMethods.h.

                                       {
  return std::reduce(data.begin(), data.end());
};

◆ addToList()

template<typename T >

void util::methods::addToList	(	const T &	i,
		std::vector< T > &	list
	)

inline

Add element to the list.

Parameters

i	Item to add
list	Vector of elements

Definition at line 294 of file vecMethods.h.

                                                      {
  for (const auto &j : list)
    if (j == i)
      return;
 
  list.emplace_back(i);
};

References max().

Referenced by contact::Damping::apply().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendKeyData()

template<typename T_out >

void util::methods::appendKeyData	(	std::string	key,
		T_out	data,
		std::map< std::string, T_out > &	data_map,
		bool	issue_err = `false`
	)

inline

Append value to data associated with key.

Parameters

key	Key to append the data to

Definition at line 351 of file vecMethods.h.

                                                                                                                 {
 
  if (data_map.find(key) == data_map.end()) {
    if (issue_err) {
      throw std::runtime_error(
          util::io::Msg()
          << "Error: key = " << key << " does not exist in data map.\n");
    }
    else {
      data_map[key] = data;
    }
  }
  else {
    data_map[key] = data_map[key] + data;
  }
};

References max().

Here is the call graph for this function:

◆ getKeyData()

template<typename T_out >

T_out util::methods::getKeyData	(	std::string	key,
		std::map< std::string, T_out > &	data_map,
		bool	issue_err = `false`
	)

inline

Get data for a key.

Parameters

key	Key to access the data

Returns: data Value of data

Definition at line 331 of file vecMethods.h.

                                                                                                   {
 
  if (issue_err) {
    if (data_map.find(key) == data_map.end()) {
      throw std::runtime_error(
          util::io::Msg()
          << "Error: key = " << key << " does not exist in data map.\n");
    }
  }
 
  return data_map[key];
};

References max().

Here is the call graph for this function:

◆ isFree() [1/2]

bool util::methods::isFree	(	const int &	i,
		const unsigned int &	dof
	)

inline

Returns true if degree of freedom is free.

Parameters

i	Fixity value
dof	Degree of freedom to probe (dof = 0 for x, dof = 1 for y, and dof = 2 for z)

Returns: True True if dof is free

Definition at line 254 of file vecMethods.h.

                                                          {
      return !(i >> dof & 1UL);
};

References max().

Referenced by PeriDEMModel::init(), and data::ModelData::isDofFree().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isFree() [2/2]

bool util::methods::isFree	(	const uint8_t &	i,
		const unsigned int &	dof
	)

inline

Returns true if degree of freedom is free.

Parameters

i	Fixity value
dof	Degree of freedom to probe (dof = 0 for x, dof = 1 for y, and dof = 2 for z)

Returns: True True if dof is free

Definition at line 259 of file vecMethods.h.

                                                              {
      return !(i >> dof & 1UL);
};

References max().

Here is the call graph for this function:

◆ isInList()

template<typename T >

bool util::methods::isInList	(	const T &	i,
		const std::vector< T > &	list
	)

inline

Find if data is in the list.

Parameters

tag	Tag to search
tags	List of tags

Returns: True True if tag exists

Definition at line 270 of file vecMethods.h.

                                                           {
      for (const auto &j : list)
        if (j == i)
          return true;
 
      return false;
};

References max().

Referenced by geom::isNumberOfParamForGeometryValid(), isTagInList(), loading::needToComputeDof(), and loading::needToProcessParticle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isTagInList()

bool util::methods::isTagInList	(	const std::string &	tag,
		const std::vector< std::string > &	tags
	)

inline

Returns true if tag is found in the list of tags.

Parameters

tag	Tag to search
tags	List of tags

Returns: True True if tag exists

Definition at line 284 of file vecMethods.h.

                                                                                {
  return isInList(tag, tags);
};

References isInList(), and max().

Referenced by rw::writer::VtkParticleWriter::appendNodes(), anonymous_namespace{vtkParticleWriter.cpp}::appendPointArraysForNodes(), geom::createGeomObjectOld(), data::setupQuadratureData(), and rw::writeOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ l2Dist()

template<class T >

T util::methods::l2Dist	(	const std::vector< T > &	x1,
		const std::vector< T > &	x2
	)

inline

Computes l2 distance between two vectors.

Parameters

x1	Vector 1
x2	Vector 2

Returns: l2_dist L2 distance

Definition at line 395 of file vecMethods.h.

                                                                {
 
  if (x1.size() != x2.size())
    throw std::invalid_argument("size of two vectors not matching");
 
  T sum = 0.;
  for (size_t i=0; i<x1.size(); i++)
    sum += (x1[i] - x2[i]) * (x1[i] - x2[i]);
 
  return std::sqrt(sum);
}

References max().

Referenced by test::testUtilMethods().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ max()

template<typename T >

T util::methods::max ( const std::vector< T > & data )

inline

Returns the maximum from list of data.

Parameters

data	List of real numbers

Returns: value Maximum value

Definition at line 76 of file vecMethods.h.

                                       {
      return data[util::methods::maxIndex(data)];
};

References maxIndex().

Referenced by addToList(), data::ModelData::appendKeyData(), appendKeyData(), data::ModelData::getKeyData(), getKeyData(), PeriDEMModel::init(), isFree(), isFree(), isInList(), isTagInList(), l2Dist(), maxIndex(), maxIndex(), maxLength(), maxLengthAndMaxLengthIndex(), maxLengthIndex(), minIndex(), minLength(), minLengthAndMinLengthIndex(), minLengthIndex(), data::ModelData::setKeyData(), setKeyData(), timeDiff(), and contact::Contact::updateSearchParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maxAndMaxIndex()

template<typename T >

std::pair< size_t, T > util::methods::maxAndMaxIndex ( const std::vector< T > & data )

inline

Returns the maximum and index of maximum from list of data.

Parameters

data	List of real numbers

Returns: pair Maximum value and index

Definition at line 96 of file vecMethods.h.

                                                                   {
      auto i = util::methods::maxIndex(data);
      return {data[i], i};
};

References maxIndex().

Here is the call graph for this function:

◆ maxIndex() [1/2]

template<typename T >

size_t util::methods::maxIndex ( const std::vector< T > & data )

inline

Returns the index corresponding to maximum from list of data.

Parameters

data	List of real numbers

Returns: i Index with a maximum value

Definition at line 40 of file vecMethods.h.

                                                 {
 
      // initialize original index locations
      std::vector<size_t> idx(data.size());
      std::iota(idx.begin(), idx.end(), 0);
 
      std::stable_sort(idx.begin(), idx.end(),
                       [&data](size_t i1, size_t i2) {return data[i1] > data[i2];});
 
      return idx[0];
};

References max().

Referenced by geom::ComplexGeomObject::center(), max(), maxAndMaxIndex(), maxLength(), maxLengthAndMaxLengthIndex(), maxLengthIndex(), and contact::Contact::updateSearchParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maxIndex() [2/2]

template<typename T >

size_t util::methods::maxIndex	(	const std::vector< T > &	data,
		size_t	data_start,
		size_t	data_end
	)

inline

Returns the index corresponding to maximum from list of data.

Parameters

data	List of real numbers

Returns: i Index with a maximum value

Definition at line 119 of file vecMethods.h.

                                                           {
 
  if (data.size() == 0) {
    throw std::runtime_error(
        util::io::Msg()
        << "Error: maxIndex() is called with data of size " << data.size()
        << ".\n");
  }
 
  if (data_end == 0 or data_end > data.size()) {
    throw std::runtime_error(
        util::io::Msg()
        << "Error: maxIndex() data_end = " << data_end
        << " is not valid for the data of size " << data.size()
        << ".\n");
  }
 
  if (data_start > data.size() - 1) {
    throw std::runtime_error(
        util::io::Msg()
        << "Error: maxIndex() data_start = " << data_start
        << " is not valid for the data of size " << data.size()
        << ".\n");
  }
 
  // initialize original index locations
  std::vector<size_t> idx(data_end - data_start);
  std::iota(idx.begin(), idx.end() , 0);
 
  std::stable_sort(idx.begin(), idx.end(),
                   [&data, &data_start](size_t i1, size_t i2)
                   {return data[i1 + data_start] > data[i2 + data_start];});
 
  return idx[0] + data_start;
};

References max().

Here is the call graph for this function:

◆ maxLength()

double util::methods::maxLength ( const std::vector< util::Point > & data )

inline

Returns the maximum length of point from list of points.

Parameters

data	List of points

Returns: value Maximum length of point

Definition at line 187 of file vecMethods.h.

                                                          {
      std::vector<double> length_data(data.size());
      for (size_t i = 0; i < data.size(); i++)
        length_data[i] = data[i].length();
 
      return length_data[util::methods::maxIndex(length_data)];
};

References max(), and maxIndex().

Here is the call graph for this function:

◆ maxLengthAndMaxLengthIndex()

std::pair< double, size_t > util::methods::maxLengthAndMaxLengthIndex ( const std::vector< util::Point > & data )

inline

Returns the maximum length of point and index from list of points.

Parameters

data	List of points

Returns: pair Maximum length of point and index

Definition at line 213 of file vecMethods.h.

                                                                                            {
      std::vector<double> length_data(data.size());
      for (size_t i = 0; i < data.size(); i++)
        length_data[i] = data[i].length();
 
      auto i = util::methods::maxIndex(length_data);
      return {length_data[i], i};
};

References max(), and maxIndex().

Referenced by postprocess::Postprocess::checkStop().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maxLengthIndex()

size_t util::methods::maxLengthIndex ( const std::vector< util::Point > & data )

inline

Returns the index that has maximum length of point from list of points.

Parameters

data	List of points

Returns: i Index with maximum length of point

Definition at line 161 of file vecMethods.h.

                                                               {
      std::vector<double> length_data(data.size());
      for (size_t i = 0; i < data.size(); i++)
        length_data[i] = data[i].length();
 
      return util::methods::maxIndex(length_data);
};

References max(), and maxIndex().

Here is the call graph for this function:

◆ min()

template<typename T >

T util::methods::min ( const std::vector< T > & data )

inline

Returns the minimim from list of data.

Parameters

data	List of real numbers

Returns: value Minimum value

Definition at line 86 of file vecMethods.h.

                                       {
      return data[util::methods::minIndex(data)];
};

References minIndex().

Here is the call graph for this function:

◆ minAndMinIndex()

template<typename T >

std::pair< size_t, T > util::methods::minAndMinIndex ( const std::vector< T > & data )

inline

Returns the minimum and index of minimum from list of data.

Parameters

data	List of real numbers

Returns: pair Minimum value and index

Definition at line 107 of file vecMethods.h.

                                                                   {
      auto i = util::methods::minIndex(data);
      return {data[i], i};
};

References minIndex().

Here is the call graph for this function:

◆ minIndex()

template<typename T >

size_t util::methods::minIndex ( const std::vector< T > & data )

inline

Returns the index corresponding to minimum from list of data.

Parameters

data	List of real numbers

Returns: i Index with a minimum value

Definition at line 58 of file vecMethods.h.

                                                 {
 
      // initialize original index locations
      std::vector<size_t> idx(data.size());
      std::iota(idx.begin(), idx.end(), 0);
 
      std::stable_sort(idx.begin(), idx.end(),
                       [&data](size_t i1, size_t i2) {return data[i1] < data[i2];});
 
      return idx[0];
};

References max().

Referenced by min(), minAndMinIndex(), minLength(), minLengthAndMinLengthIndex(), and minLengthIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ minLength()

double util::methods::minLength ( const std::vector< util::Point > & data )

inline

Returns the minimum length of point from list of points.

Parameters

data	List of points

Returns: value Minimum length of point

Definition at line 200 of file vecMethods.h.

                                                          {
      std::vector<double> length_data(data.size());
      for (size_t i = 0; i < data.size(); i++)
        length_data[i] = data[i].length();
 
      return length_data[util::methods::minIndex(length_data)];
};

References max(), and minIndex().

Here is the call graph for this function:

◆ minLengthAndMinLengthIndex()

std::pair< double, size_t > util::methods::minLengthAndMinLengthIndex ( const std::vector< util::Point > & data )

inline

Returns the minimum length of point and index from list of points.

Parameters

data	List of points

Returns: pair Minimum length of point and index

Definition at line 227 of file vecMethods.h.

                                                                                            {
      std::vector<double> length_data(data.size());
      for (size_t i = 0; i < data.size(); i++)
        length_data[i] = data[i].length();
 
      auto i = util::methods::minIndex(length_data);
      return {length_data[i], i};
};

References max(), and minIndex().

Here is the call graph for this function:

◆ minLengthIndex()

size_t util::methods::minLengthIndex ( const std::vector< util::Point > & data )

inline

Returns the index that has minimum length of point from list of points.

Parameters

data	List of points

Returns: i Index with minimum length of point

Definition at line 174 of file vecMethods.h.

                                                               {
  std::vector<double> length_data(data.size());
  for (size_t i = 0; i < data.size(); i++)
    length_data[i] = data[i].length();
 
  return util::methods::minIndex(length_data);
};

References max(), and minIndex().

Here is the call graph for this function:

◆ setKeyData()

template<typename T_out >

void util::methods::setKeyData	(	std::string	key,
		T_out	data,
		std::map< std::string, T_out > &	data_map,
		bool	issue_err = `false`
	)

inline

Set value to data associated with key.

Parameters

key	Key to append the data to

Definition at line 374 of file vecMethods.h.

                                                                                                              {
 
  if (data_map.find(key) == data_map.end()) {
    if (issue_err) {
      throw std::runtime_error(
          util::io::Msg()
          << "Error: key = " << key << " does not exist in data map.\n");
    }
  }
 
  data_map[key] = data;
};

References max().

Here is the call graph for this function:

◆ timeDiff()

float util::methods::timeDiff	(	std::chrono::steady_clock::time_point	begin,
		std::chrono::steady_clock::time_point	end,
		std::string	unit = `"microseconds"`
	)

inline

Returns difference between two times.

Parameters

begin	Beginning time
end	Ending time
unit	Unit in which time difference is to be returned

Returns: time Time difference

Definition at line 309 of file vecMethods.h.

                                                                                      {
      if (unit == "microseconds")
        return std::chrono::duration_cast<std::chrono::microseconds>(end - begin).count();
      else if (unit == "milliseconds")
        return std::chrono::duration_cast<std::chrono::milliseconds>(end - begin).count();
      else if (unit == "seconds")
        return std::chrono::duration_cast<std::chrono::seconds>(end - begin).count();
      else {
        throw std::runtime_error(
            util::io::Msg()
            << "Unit = " << unit << " not valid.\n");
      }
};

References max().

Referenced by PeriDEMModel::computeForces(), pd::exchangeGhostDisplacement(), particle::exchangeGhostKinematics(), pd::exchangeGhostTheta(), PeriDEMModel::init(), time_int::Integrator::integrate(), main(), mesh::metisGraphPartition(), nsearch::NFlannSearchKd< dim >::setInputCloud(), test::testGraphPartitioning(), test::testTaskflow(), and test::testTriElemTime().

Here is the call graph for this function:

Here is the caller graph for this function:

Functions

Detailed Description

Function Documentation

◆ add()

◆ addToList()

◆ appendKeyData()

◆ getKeyData()

◆ isFree() [1/2]

◆ isFree() [2/2]

◆ isInList()

◆ isTagInList()

◆ l2Dist()

◆ max()

◆ maxAndMaxIndex()

◆ maxIndex() [1/2]

◆ maxIndex() [2/2]

◆ maxLength()

◆ maxLengthAndMaxLengthIndex()

◆ maxLengthIndex()

◆ min()

◆ minAndMinIndex()

◆ minIndex()

◆ minLength()

◆ minLengthAndMinLengthIndex()

◆ minLengthIndex()

◆ setKeyData()

◆ timeDiff()