Molassembler  1.0.0
Molecule graph and conformer library
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Namespaces | Functions
Numeric.h File Reference

Stubs to work with numeric data. More...

#include "Molassembler/Temple/Traits.h"
#include "Molassembler/Temple/constexpr/Math.h"
#include <numeric>
#include <functional>
#include <cassert>
Include dependency graph for Numeric.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

 Scine
 
 Scine::Molassembler
 Central library namespace.
 
 Scine::Molassembler::Temple
 Template shorthands, optimizers and constexpr data types.
 

Functions

template<class ContainerType >
constexpr Traits::getValueType
< ContainerType > 		Scine::Molassembler::Temple::sum (const ContainerType &container)
 Summation with zero-initialization. More...
 
template<class ContainerType >
constexpr std::enable_if_t
< std::is_floating_point
< Traits::getValueType
< ContainerType > >::value,
Traits::getValueType
< ContainerType >> 		Scine::Molassembler::Temple::average (const ContainerType &container)
 
template<class ContainerType >
constexpr std::enable_if_t
< !std::is_floating_point
< Traits::getValueType
< ContainerType > >::value,
double > 		Scine::Molassembler::Temple::average (const ContainerType &container)
 
template<class ContainerType >
constexpr std::enable_if_t
< std::is_floating_point
< Traits::getValueType
< ContainerType > >::value,
Traits::getValueType
< ContainerType >> 		Scine::Molassembler::Temple::geometricMean (const ContainerType &container)
 Geometric average of all values in a container. More...
 
template<class ContainerType , typename FloatingType >
constexpr std::enable_if_t
< std::is_floating_point
< FloatingType >::value,
FloatingType > 		Scine::Molassembler::Temple::stddev (const ContainerType &container, const FloatingType averageValue)
 Calculate the standard deviation of a container with a known average. More...
 
template<class ContainerType >
constexpr auto Scine::Molassembler::Temple::stddev (const ContainerType &container)
 
template<class ContainerType >
constexpr auto Scine::Molassembler::Temple::min (const ContainerType &container)
 Composable min_element function. Returns the smallest value of any container. More...
 
template<class ContainerType >
constexpr auto Scine::Molassembler::Temple::max (const ContainerType &container)
 Composable max function. Returns the smallest value of any container. More...
 

Detailed Description

Stubs to work with numeric data.

Copyright
This code is licensed under the 3-clause BSD license. Copyright ETH Zurich, Laboratory of Physical Chemistry, Reiher Group. See LICENSE.txt for details. Exposes a small set of functions for working with numbers in containers.
  • Basic summation
  • Average
  • Geometric mean
  • Standard deviation
  • Minimum and maximum element