yoda is hosted by Hepforge, IPPP Durham
YODA - Yet more Objects for Data Analysis 2.0.2
Public Types | Public Member Functions | Protected Types | List of all members
YODA::ScatterND< N > Class Template Reference

A generic data type which is just a collection of n-dim data points with errors. More...

#include <Scatter.h>

Inheritance diagram for YODA::ScatterND< N >:
YODA::AnalysisObject YODA::Scatter

Public Types

using NdVal = Utils::ndarray< double, N >
 
using NdValPair = Utils::ndarray< std::pair< double, double >, N >
 
using Point = PointND< N >
 
using Points = Utils::sortedvector< Point >
 
using Ptr = std::shared_ptr< ScatterND >
 
- Public Types inherited from YODA::AnalysisObject
typedef std::map< std::string, std::string > Annotations
 Collection type for annotations, as a string-string map.
 

Public Member Functions

size_t dim () const noexcept
 Dimension of this data object.
 
Constructors
 ScatterND (const std::string &path="", const std::string &title="")
 Empty constructor.
 
 ScatterND (const Points &points, const std::string &path="", const std::string &title="")
 Constructor from a set of points.
 
 ScatterND (Points &&points, const std::string &path="", const std::string &title="")
 Constructor from a set of rvalue points.
 
template<typename ValRange = std::initializer_list<ValList>, typename = std::enable_if_t<isIterable<ValRange, containedType<ValRange>>>>
 ScatterND (ValRange &&positions, const std::string &path="", const std::string &title="")
 Constructor from a vector of position values with no errors.
 
template<typename ValRange = std::initializer_list<ValList>, typename = std::enable_if_t<isIterable<ValRange, containedType<ValRange>>>>
 ScatterND (ValRange &&positions, ValRange &&errors, const std::string &path="", const std::string &title="")
 Constructor from vectors of values for positions and a single set of symmetric errors.
 
template<typename ValRange = std::initializer_list<ValList>, typename PairRange = std::initializer_list<PairList>, typename = enableIfNestedArrayWithPair<ValRange,PairRange>>
 ScatterND (ValRange &&positions, PairRange &&errors, const std::string &path="", const std::string &title="")
 Constructor from vectors of values for positions and a single set of symmetric errors.
 
 ScatterND (const ScatterND< N > &s, const std::string &path="")
 Copy constructor with optional new path.
 
 ScatterND (ScatterND< N > &&s, const std::string &path="")
 Move constructor with optional new path.
 
ScatterND< N > & operator= (const ScatterND< N > &s)
 Assignment operator.
 
ScatterND< N > & operator= (ScatterND< N > &&s)
 Move operator.
 
ScatterND< N > clone () const
 Make a copy on the stack.
 
ScatterND< N > * newclone () const
 Make a copy on the heap, via 'new'.
 
Modifiers
void reset ()
 Clear all points.
 
void scale (const NdVal &scales)
 Scaling.
 
void scale (const std::vector< double > &scales)
 
void scale (const size_t i, double factor)
 Scale value and error along direction i.
 
void scaleVal (const size_t i, double factor)
 Scale value along direction i.
 
void scaleErr (const size_t i, double factor)
 Scale error along direction i.
 
Point accessors
size_t numPoints () const
 Number of points in the scatter.
 
Points & points ()
 Get the collection of points.
 
const Points & points () const
 Get the collection of points (const version)
 
PointND< N > & point (size_t index)
 Get a reference to the point with index index.
 
const PointND< N > & point (size_t index) const
 Get the point with index index (const version)
 
MPI (de-)serialisation
size_t lengthContent (bool fixed_length=false) const noexcept
 Length of serialized content vector for MPI reduce operations.
 
std::vector< double > serializeContent (bool fixed_length=false) const noexcept
 Content serialisation for MPI reduce operations.
 
void deserializeContent (const std::vector< double > &data)
 Content deserialisation for MPI reduce operations.
 
Combining sets of scatter points
ScatterND< N > & combineWith (const ScatterND< N > &other)
 
ScatterND< N > & combineWith (ScatterND< N > &&other)
 
ScatterND< N > & combineWith (const std::vector< ScatterND< N > > &others)
 
ScatterND< N > & combineWith (std::vector< ScatterND< N > > &&others)
 
Coordinate accessors
ValVec vals (const size_t i) const
 Get the coordinate vector along axis i.
 
ValVec mins (const size_t i) const
 Get the lowest value vector along axis i.
 
ValVec maxs (const size_t i) const
 Get the positive error vector along axis i.
 
double min (const size_t i) const
 Get the smallest central value along axis i.
 
double max (const size_t i) const
 Get the largest central value along axis i.
 
PairVec errs (const size_t i) const
 Get the error pairs along axis i.
 
ValVec errAvgs (const size_t i) const
 Get the average error along axis i.
 
ValVec xVals () const
 Axis-specific alias.
 
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 2)>>
ValVec yVals () const
 Axis-specific alias.
 
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 3)>>
ValVec zVals () const
 Axis-specific alias.
 
ValVec xMins () const
 Axis-specific alias.
 
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 2)>>
ValVec yMins () const
 Axis-specific alias.
 
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 3)>>
ValVec zMins () const
 Axis-specific alias.
 
ValVec xMaxs () const
 Axis-specific alias.
 
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 2)>>
ValVec yMaxs () const
 Axis-specific alias.
 
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 3)>>
ValVec zMaxs () const
 Axis-specific alias.
 
double xMin () const
 Axis-specific alias.
 
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 2)>>
double yMin () const
 Axis-specific alias.
 
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 3)>>
double zMin () const
 Axis-specific alias.
 
double xMax () const
 Axis-specific alias.
 
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 2)>>
double yMax () const
 Axis-specific alias.
 
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 3)>>
double zMax () const
 Axis-specific alias.
 
PairVec xErrs () const
 Axis-specific alias.
 
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 2)>>
PairVec yErrs () const
 Axis-specific alias.
 
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 3)>>
PairVec zErrs () const
 Axis-specific alias.
 
ValVec xErrAvgs () const
 Axis-specific alias.
 
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 2)>>
ValVec yErrAvgs () const
 Axis-specific alias.
 
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 3)>>
ValVec zErrAvgs () const
 Axis-specific alias.
 
Utilities
std::vector< Pair > edges (const size_t i) const
 
- Public Member Functions inherited from YODA::AnalysisObject
 AnalysisObject ()
 Default constructor.
 
 AnalysisObject (const std::string &type, const std::string &path, const std::string &title="")
 Constructor giving a type, a path and an optional title.
 
 AnalysisObject (const std::string &type, const std::string &path, const AnalysisObject &ao, const std::string &title="")
 Constructor giving a type, a path, another AO to copy annotation from, and an optional title.
 
virtual ~AnalysisObject ()
 Default destructor.
 
virtual AnalysisObject & operator= (const AnalysisObject &ao) noexcept
 Default copy assignment operator.
 
std::vector< std::string > annotations () const
 
bool hasAnnotation (const std::string &name) const
 Check if an annotation is defined.
 
const std::string & annotation (const std::string &name) const
 Get an annotation by name (as a string)
 
const std::string & annotation (const std::string &name, const std::string &defaultreturn) const
 Get an annotation by name (as a string) with a default in case the annotation is not found.
 
template<typename T >
const T annotation (const std::string &name) const
 Get an annotation by name (copied to another type)
 
template<typename T >
const T annotation (const std::string &name, const T &defaultreturn) const
 Get an annotation by name (copied to another type) with a default in case the annotation is not found.
 
template<typename T >
void setAnnotation (const std::string &name, const T &value)
 Add or set an annotation by name (templated for remaining types)
 
void setAnnotations (const Annotations &anns)
 Set all annotations at once.
 
template<typename T >
void addAnnotation (const std::string &name, const T &value)
 Add or set an annotation by name.
 
void rmAnnotation (const std::string &name)
 Delete an annotation by name.
 
void clearAnnotations ()
 Delete an annotation by name.
 
const std::string title () const
 Get the AO title.
 
void setTitle (const std::string &title)
 Set the AO title.
 
const std::string path () const
 Get the AO path.
 
void setPath (const std::string &path)
 
const std::string name () const
 
virtual std::string type () const
 Get name of the analysis object type.
 
virtual AnalysisObject * mkInert (const std::string &path="", const std::string &source="") const noexcept
 Return an inert version of the analysis object (e.g. scatter, estimate)
 
size_t lengthMeta (const bool skipPath=true, const bool skipTitle=true) const noexcept
 Length of serialized meta-data vector for MPI reduce operations.
 
std::vector< std::string > serializeMeta (const bool skipPath=true, const bool skipTitle=true) const noexcept
 Mate-data serialisation for MPI reduce operations.
 
virtual void deserializeMeta (const std::vector< std::string > &data, const bool resetPath=false, const bool resetTitle=false)
 Mate-data deserialisation for MPI reduce operations.
 
- Public Member Functions inherited from YODA::Scatter
virtual ~Scatter ()
 Virtual destructor for inheritance.
 
virtual void rmPoints (std::vector< size_t > indices)
 Safely remove the points with indices indices.
 

Protected Types

using Pair = std::pair< double, double >
 
using ValVec = std::vector< double >
 
using PairVec = std::vector< Pair >
 
using ValList = std::initializer_list< double >
 
using PairList = std::initializer_list< Pair >
 
template<typename Arr >
using containedType = std::decay_t< decltype(*std::declval< Arr >().begin())>
 
template<typename Arr >
using containsPair = typename std::is_same< containedType< Arr >, Pair >
 
template<typename T , typename U >
using enableIfNestedArrayWithPair = std::enable_if_t<(isIterable< T, U, containedType< T >, containedType< U > > &&containsPair< containedType< U > >::value)>
 
template<typename... Args>
using isAllVals = std::is_same< double, std::common_type_t< Args..., double > >
 
template<typename... Args>
using isHalfValsHalfPairs = HalfValsHalfPairs< std::tuple< Args... >, std::make_index_sequence< N > >
 

Point inserters/removers

ScatterND< N > & addPoint (const PointND< N > &pt)
 Insert a new point.
 
ScatterND< N > & addPoint (PointND< N > &&pt)
 Insert a new rvalue point.
 
template<typename ValRange = ValList, typename = std::enable_if_t<isIterable<ValRange>>>
ScatterND< N > & addPoint (ValRange &&pos)
 Insert a new point from a position array (of N elements)
 
template<typename ValRange = ValList, typename = std::enable_if_t<isIterable<ValRange>>>
ScatterND< N > & addPoint (ValRange &&pos, ValRange &&err)
 Insert a new point from position and symmetric error arrays (of N elements)
 
template<typename ValRange = ValList, typename = std::enable_if_t<isIterable<ValRange>>>
ScatterND< N > & addPoint (ValRange &&pos, ValRange &&errdn, ValRange &&errup)
 Insert a new point from position and asymmetric error arrays (of N elements)
 
template<typename ValRange = ValList, typename PairRange = PairList>
auto addPoint (ValRange &&pos, PairRange &&err) -> std::enable_if_t<(isIterable< ValRange, PairRange > &&containsPair< PairRange >::value), ScatterND< N > > &
 Insert a new point from a position and error-pair array.
 
template<typename... Args>
auto addPoint (Args &&... args) -> std::enable_if_t<(sizeof...(Args)==2 *N||sizeof...(Args)==3 *N), ScatterND< N > > &
 
ScatterND< N > & addPoints (Points pts)
 Insert a collection of new points.
 
void rmPoint (size_t index)
 Remove the point with index index.
 
template<typename... Args, size_t... Is>
auto addPoint_aux (std::tuple< Args... > &&t, std::index_sequence< Is... >) -> std::enable_if_t<(isAllVals< Args... >::value), ScatterND< N > > &
 
template<typename... Args, size_t... Is>
auto addPoint_aux (std::tuple< Args... > &&t, std::index_sequence< Is... >) -> std::enable_if_t<(sizeof...(Args)==2 *N &&isHalfValsHalfPairs< Args... >::value), ScatterND< N > > &
 

Detailed Description

template<size_t N>
class YODA::ScatterND< N >

A generic data type which is just a collection of n-dim data points with errors.

Definition at line 154 of file Scatter.h.

Member Typedef Documentation

◆ containedType

template<size_t N>
template<typename Arr >
using YODA::ScatterND< N >::containedType = std::decay_t<decltype(*std::declval<Arr>().begin())>
protected

Definition at line 166 of file Scatter.h.

◆ containsPair

template<size_t N>
template<typename Arr >
using YODA::ScatterND< N >::containsPair = typename std::is_same<containedType<Arr>, Pair>
protected

Definition at line 170 of file Scatter.h.

◆ enableIfNestedArrayWithPair

template<size_t N>
template<typename T , typename U >
using YODA::ScatterND< N >::enableIfNestedArrayWithPair = std::enable_if_t<(isIterable<T,U,containedType<T>,containedType<U> > && containsPair<containedType<U> >::value)>
protected

Definition at line 175 of file Scatter.h.

◆ isAllVals

template<size_t N>
template<typename... Args>
using YODA::ScatterND< N >::isAllVals = std::is_same<double, std::common_type_t<Args..., double> >
protected

Definition at line 180 of file Scatter.h.

◆ isHalfValsHalfPairs

template<size_t N>
template<typename... Args>
using YODA::ScatterND< N >::isHalfValsHalfPairs = HalfValsHalfPairs<std::tuple<Args...>, std::make_index_sequence<N> >
protected

Definition at line 186 of file Scatter.h.

◆ NdVal

template<size_t N>
using YODA::ScatterND< N >::NdVal = Utils::ndarray<double, N>

Definition at line 191 of file Scatter.h.

◆ NdValPair

template<size_t N>
using YODA::ScatterND< N >::NdValPair = Utils::ndarray<std::pair<double,double>, N>

Definition at line 192 of file Scatter.h.

◆ Pair

template<size_t N>
using YODA::ScatterND< N >::Pair = std::pair<double,double>
protected

Definition at line 158 of file Scatter.h.

◆ PairList

template<size_t N>
using YODA::ScatterND< N >::PairList = std::initializer_list<Pair>
protected

Definition at line 162 of file Scatter.h.

◆ PairVec

template<size_t N>
using YODA::ScatterND< N >::PairVec = std::vector<Pair>
protected

Definition at line 160 of file Scatter.h.

◆ Point

template<size_t N>
using YODA::ScatterND< N >::Point = PointND<N>

Definition at line 193 of file Scatter.h.

◆ Points

template<size_t N>
using YODA::ScatterND< N >::Points = Utils::sortedvector<Point>

Definition at line 194 of file Scatter.h.

◆ Ptr

template<size_t N>
using YODA::ScatterND< N >::Ptr = std::shared_ptr<ScatterND>

Definition at line 195 of file Scatter.h.

◆ ValList

template<size_t N>
using YODA::ScatterND< N >::ValList = std::initializer_list<double>
protected

Definition at line 161 of file Scatter.h.

◆ ValVec

template<size_t N>
using YODA::ScatterND< N >::ValVec = std::vector<double>
protected

Definition at line 159 of file Scatter.h.

Constructor & Destructor Documentation

◆ ScatterND() [1/8]

template<size_t N>
YODA::ScatterND< N >::ScatterND ( const std::string &  path = "",
const std::string &  title = "" 
)
inline

Empty constructor.

Definition at line 203 of file Scatter.h.

204 : AnalysisObject("Scatter"+std::to_string(N)+"D", path, title) { }
YODA::AnalysisObject::title
const std::string title() const
Get the AO title.
Definition AnalysisObject.h:217
YODA::AnalysisObject::path
const std::string path() const
Get the AO path.
Definition AnalysisObject.h:230
YODA::AnalysisObject::AnalysisObject
AnalysisObject()
Default constructor.
Definition AnalysisObject.h:33

◆ ScatterND() [2/8]

template<size_t N>
YODA::ScatterND< N >::ScatterND ( const Points &  points,
const std::string &  path = "",
const std::string &  title = "" 
)
inline

Constructor from a set of points.

Definition at line 207 of file Scatter.h.

209 : AnalysisObject("Scatter"+std::to_string(N)+"D", path, title),
210 _points(points) { }
YODA::ScatterND::points
Points & points()
Get the collection of points.
Definition Scatter.h:350

◆ ScatterND() [3/8]

template<size_t N>
YODA::ScatterND< N >::ScatterND ( Points &&  points,
const std::string &  path = "",
const std::string &  title = "" 
)
inline

Constructor from a set of rvalue points.

Definition at line 213 of file Scatter.h.

215 : AnalysisObject("Scatter"+std::to_string(N)+"D", path, title),
216 _points(std::move(points)) { }

◆ ScatterND() [4/8]

template<size_t N>
template<typename ValRange = std::initializer_list<ValList>, typename = std::enable_if_t<isIterable<ValRange, containedType<ValRange>>>>
YODA::ScatterND< N >::ScatterND ( ValRange &&  positions,
const std::string &  path = "",
const std::string &  title = "" 
)
inline

Constructor from a vector of position values with no errors.

Definition at line 221 of file Scatter.h.

222 : AnalysisObject("Scatter"+std::to_string(N)+"D", path, title) {
223 for (size_t i = 0; i < positions.size(); ++i) {
224 addPoint(PointND<N>(std::forward<containedType<ValRange>>(positions[i])));
225 }
226 }
YODA::ScatterND::addPoint
ScatterND< N > & addPoint(const PointND< N > &pt)
Insert a new point.
Definition Scatter.h:379

References YODA::ScatterND< N >::addPoint().

◆ ScatterND() [5/8]

template<size_t N>
template<typename ValRange = std::initializer_list<ValList>, typename = std::enable_if_t<isIterable<ValRange, containedType<ValRange>>>>
YODA::ScatterND< N >::ScatterND ( ValRange &&  positions,
ValRange &&  errors,
const std::string &  path = "",
const std::string &  title = "" 
)
inline

Constructor from vectors of values for positions and a single set of symmetric errors.

Definition at line 231 of file Scatter.h.

232 : AnalysisObject("Scatter"+std::to_string(N)+"D", path, title) {
233 if (positions.size() != errors.size()) throw RangeError("Number of errors doesn't match number of positions");
234 for (size_t i = 0; i < positions.size(); ++i) {
235 addPoint(PointND<N>(std::forward<containedType<ValRange>>(positions[i]),
236 std::forward<containedType<ValRange>>(errors[i])));
237 }
238 }

References YODA::ScatterND< N >::addPoint().

◆ ScatterND() [6/8]

template<size_t N>
template<typename ValRange = std::initializer_list<ValList>, typename PairRange = std::initializer_list<PairList>, typename = enableIfNestedArrayWithPair<ValRange,PairRange>>
YODA::ScatterND< N >::ScatterND ( ValRange &&  positions,
PairRange &&  errors,
const std::string &  path = "",
const std::string &  title = "" 
)
inline

Constructor from vectors of values for positions and a single set of symmetric errors.

Definition at line 244 of file Scatter.h.

245 : AnalysisObject("Scatter"+std::to_string(N)+"D", path, title) {
246 if (positions.size() != errors.size()) throw RangeError("Number of error pairs doesn't match number of positions");
247 for (size_t i = 0; i < positions.size(); ++i) {
248 addPoint(PointND<N>(std::forward<containedType<ValRange>>(positions[i]),
249 std::forward<containedType<PairRange>>(errors[i])));
250 }
251 }

References YODA::ScatterND< N >::addPoint().

◆ ScatterND() [7/8]

template<size_t N>
YODA::ScatterND< N >::ScatterND ( const ScatterND< N > &  s,
const std::string &  path = "" 
)
inline

Copy constructor with optional new path.

Definition at line 254 of file Scatter.h.

255 : AnalysisObject("Scatter"+std::to_string(N)+"D", (path != "")? path : s.path(), s, s.title()),
256 _points(s._points) { }

◆ ScatterND() [8/8]

template<size_t N>
YODA::ScatterND< N >::ScatterND ( ScatterND< N > &&  s,
const std::string &  path = "" 
)
inline

Move constructor with optional new path.

Definition at line 259 of file Scatter.h.

260 : AnalysisObject("Scatter"+std::to_string(N)+"D", (path != "")? path : s.path(), s, s.title()),
261 _points(std::move(s._points)) {
262 }

Member Function Documentation

◆ addPoint() [1/7]

template<size_t N>
template<typename... Args>
auto YODA::ScatterND< N >::addPoint ( Args &&...  args) -> std::enable_if_t<(sizeof...(Args) == 2*N || sizeof...(Args) == 3*N), ScatterND<N>>&
inline

Insert a new point from a parameter pack

The deduction guide on the parameter pack asks that its length be 2N or 3N for dimension N.

If accepted, the parameter pack is then forwarded as a tuple to the helper method addPoint_aux, which is overloaded to deal with the following three cases:

Case 1: position and symmetric errors: Scatter1D::addPoint(x, ex); Scatter2D::addPoint(x,y, ex,ey); ... Case 2: position and asymmetric errors: Scatter1D::addPoint(x, exdn,exup); Scatter2D::addPoint(x,y, exdn,eydn, exup,eyup); ... Case 3: position and error pairs Scatter1D::addPoint(x, make_pair(exdn,exup)); Scatter2D::addPoint(x,y, make_pair(exdn,eydn), make_pair(exup,eyup)); ...

Definition at line 446 of file Scatter.h.

447 {
448 return addPoint_aux(std::make_tuple(std::forward<Args>(args)...), std::make_index_sequence<N>{});
449 }
YODA::ScatterND::addPoint_aux
auto addPoint_aux(std::tuple< Args... > &&t, std::index_sequence< Is... >) -> std::enable_if_t<(isAllVals< Args... >::value), ScatterND< N > > &
Definition Scatter.h:469

References YODA::ScatterND< N >::addPoint_aux().

◆ addPoint() [2/7]

template<size_t N>
ScatterND< N > & YODA::ScatterND< N >::addPoint ( const PointND< N > &  pt)
inline

Insert a new point.

Definition at line 379 of file Scatter.h.

379 {
380 _points.insert(pt);
381 return *this;
382 }

Referenced by YODA::ScatterND< N >::addPoints(), YODA::ScatterND< N >::deserializeContent(), YODA::mkScatter(), YODA::Counter::mkScatter(), YODA::Estimate0D::mkScatter(), YODA::EstimateStorage< AxisT >::mkScatter(), YODA::ScatterND< N >::ScatterND(), YODA::ScatterND< N >::ScatterND(), YODA::ScatterND< N >::ScatterND(), and YODA::zipProfiles().

◆ addPoint() [3/7]

template<size_t N>
ScatterND< N > & YODA::ScatterND< N >::addPoint ( PointND< N > &&  pt)
inline

Insert a new rvalue point.

Definition at line 385 of file Scatter.h.

385 {
386 _points.insert(std::move(pt));
387 return *this;
388 }

◆ addPoint() [4/7]

template<size_t N>
template<typename ValRange = ValList, typename = std::enable_if_t<isIterable<ValRange>>>
ScatterND< N > & YODA::ScatterND< N >::addPoint ( ValRange &&  pos)
inline

Insert a new point from a position array (of N elements)

Definition at line 393 of file Scatter.h.

393 {
394 _points.insert(PointND<N>(std::forward<ValRange>(pos)));
395 return *this;
396 }

◆ addPoint() [5/7]

template<size_t N>
template<typename ValRange = ValList, typename PairRange = PairList>
auto YODA::ScatterND< N >::addPoint ( ValRange &&  pos,
PairRange &&  err 
) -> std::enable_if_t<(isIterable<ValRange,PairRange> && containsPair<PairRange>::value), ScatterND<N>>&
inline

Insert a new point from a position and error-pair array.

Definition at line 418 of file Scatter.h.

419 {
420 _points.insert(PointND<N>(pos, err));
421 return *this;
422 }

◆ addPoint() [6/7]

template<size_t N>
template<typename ValRange = ValList, typename = std::enable_if_t<isIterable<ValRange>>>
ScatterND< N > & YODA::ScatterND< N >::addPoint ( ValRange &&  pos,
ValRange &&  err 
)
inline

Insert a new point from position and symmetric error arrays (of N elements)

Definition at line 401 of file Scatter.h.

401 {
402 _points.insert(PointND<N>(std::forward<ValRange>(pos), std::forward<ValRange>(err)));
403 return *this;
404 }

◆ addPoint() [7/7]

template<size_t N>
template<typename ValRange = ValList, typename = std::enable_if_t<isIterable<ValRange>>>
ScatterND< N > & YODA::ScatterND< N >::addPoint ( ValRange &&  pos,
ValRange &&  errdn,
ValRange &&  errup 
)
inline

Insert a new point from position and asymmetric error arrays (of N elements)

Definition at line 409 of file Scatter.h.

409 {
410 _points.insert(PointND<N>(std::forward<ValRange>(pos),
411 std::forward<ValRange>(errdn),
412 std::forward<ValRange>(errup)));
413 return *this;
414 }

◆ addPoint_aux() [1/2]

template<size_t N>
template<typename... Args, size_t... Is>
auto YODA::ScatterND< N >::addPoint_aux ( std::tuple< Args... > &&  t,
std::index_sequence< Is... >   
) -> std::enable_if_t<(isAllVals<Args...>::value), ScatterND<N>>&
inlineprotected

Helper method to deal with parameter pack that has been forwarded as a tuple from addPoints.

The deduction guide on the parameter pack asks that all arguments can be cast to double, thereby covering the following two cases:

Case 1: position and symmetric errors: Scatter1D::addPoint(x, ex); Scatter2D::addPoint(x,y, ex,ey); ... Case 2: position and asymmetric errors: Scatter1D::addPoint(x, exdn,exup); Scatter2D::addPoint(x,y, exdn,eydn, exup,eyup); ...

Definition at line 469 of file Scatter.h.

470 {
471 if constexpr(sizeof...(Args) == 2*N) { // Case 1: symmetric errors
472 _points.insert(
473 PointND<N>( ValVec{ static_cast<double>(std::get<Is>(t))...},
474 PairVec{{static_cast<double>(std::get<N+Is>(t)),
475 static_cast<double>(std::get<N+Is>(t))}...} ));
476 }
477 else { // Case 2: asymmetric errors
478 _points.insert(PointND<N>( ValVec{ static_cast<double>(std::get<Is>(t))...},
479 PairVec{{static_cast<double>(std::get<N+2*Is>(t)),
480 static_cast<double>(std::get<N+2*Is+1>(t))}...} ));
481 }
482 return *this;
483 }
YODA::ScatterND::PairVec
std::vector< Pair > PairVec
Definition Scatter.h:160
YODA::ScatterND::ValVec
std::vector< double > ValVec
Definition Scatter.h:159

Referenced by YODA::ScatterND< N >::addPoint().

◆ addPoint_aux() [2/2]

template<size_t N>
template<typename... Args, size_t... Is>
auto YODA::ScatterND< N >::addPoint_aux ( std::tuple< Args... > &&  t,
std::index_sequence< Is... >   
) -> std::enable_if_t<(sizeof...(Args) == 2*N && isHalfValsHalfPairs<Args...>::value), ScatterND<N>>&
inlineprotected

Helper method to deal with parameter pack that has been forwarded as a tuple from addPoints.

The deduction guide on the parameter pack asks that its length be 2N for dimension N, that the first half of the arguments can be cast to double, and that the second half can be cast to Pair, thereby covering the following case:

Case 3: position and error pairs Scatter1D::addPoint(x, make_pair(exdn,exup)); Scatter2D::addPoint(x,y, make_pair(exdn,eydn), make_pair(exup,eyup)); ...

Definition at line 500 of file Scatter.h.

501 {
502 _points.insert(PointND<N>( ValVec{ static_cast<double>(std::get<Is>(t))...},
503 PairVec{ static_cast<Pair>(std::get<N+Is>(t))...} ));
504 return *this;
505 }
YODA::ScatterND::Pair
std::pair< double, double > Pair
Definition Scatter.h:158

◆ addPoints()

template<size_t N>
ScatterND< N > & YODA::ScatterND< N >::addPoints ( Points  pts)
inline

Insert a collection of new points.

Definition at line 511 of file Scatter.h.

511 {
512 for (const PointND<N>& pt : pts) addPoint(pt);
513 return *this;
514 }

References YODA::ScatterND< N >::addPoint().

Referenced by YODA::ScatterND< N >::combineWith(), and YODA::ScatterND< N >::combineWith().

◆ clone()

template<size_t N>
ScatterND< N > YODA::ScatterND< N >::clone ( ) const
inline

Make a copy on the stack.

Definition at line 284 of file Scatter.h.

284 {
285 return ScatterND<N>(*this);
286 }

Referenced by YODA::WriterYODA1::writeScatter1D(), YODA::WriterYODA1::writeScatter2D(), and YODA::WriterYODA1::writeScatter3D().

◆ combineWith() [1/4]

template<size_t N>
ScatterND< N > & YODA::ScatterND< N >::combineWith ( const ScatterND< N > &  other)
inline
Todo:
Better name?

Definition at line 568 of file Scatter.h.

568 {
569 addPoints(other.points());
570 return *this;
571 }
YODA::ScatterND::addPoints
ScatterND< N > & addPoints(Points pts)
Insert a collection of new points.
Definition Scatter.h:511

References YODA::ScatterND< N >::addPoints(), and YODA::ScatterND< N >::points().

Referenced by YODA::combine(), YODA::combine(), YODA::combine(), YODA::combine(), YODA::ScatterND< N >::combineWith(), and YODA::ScatterND< N >::combineWith().

◆ combineWith() [2/4]

template<size_t N>
ScatterND< N > & YODA::ScatterND< N >::combineWith ( const std::vector< ScatterND< N > > &  others)
inline
Todo:
Better name?

Definition at line 580 of file Scatter.h.

580 {
581 for (const ScatterND<N>& s : others) combineWith(s);
582 return *this;
583 }
YODA::ScatterND::combineWith
ScatterND< N > & combineWith(const ScatterND< N > &other)
Definition Scatter.h:568

References YODA::ScatterND< N >::combineWith().

◆ combineWith() [3/4]

template<size_t N>
ScatterND< N > & YODA::ScatterND< N >::combineWith ( ScatterND< N > &&  other)
inline
Todo:
Better name?

Definition at line 574 of file Scatter.h.

574 {
575 addPoints(std::move(other._points));
576 return *this;
577 }

References YODA::ScatterND< N >::addPoints().

◆ combineWith() [4/4]

template<size_t N>
ScatterND< N > & YODA::ScatterND< N >::combineWith ( std::vector< ScatterND< N > > &&  others)
inline
Todo:
Better name?

Definition at line 586 of file Scatter.h.

586 {
587 for (ScatterND<N>&& s : others) combineWith(std::move(s));
588 return *this;
589 }

References YODA::ScatterND< N >::combineWith().

◆ deserializeContent()

template<size_t N>
void YODA::ScatterND< N >::deserializeContent ( const std::vector< double > &  data)
inlinevirtual

Content deserialisation for MPI reduce operations.

Implements YODA::AnalysisObject.

Definition at line 545 of file Scatter.h.

545 {
546
547 if (data.size() % Point::DataSize::value)
548 throw UserError("Length of serialized data should be a multiple of "+std::to_string(Point::DataSize::value)+"!");
549
550 const size_t nPoints = data.size()/Point::DataSize::value;
551 const auto itr = data.cbegin();
552 reset();
553 for (size_t i = 0; i < nPoints; ++i) {
554 addPoint(Point());
555 auto first = itr + i*Point::DataSize::value;
556 auto last = first + Point::DataSize::value;
557 point(i)._deserializeContent(std::vector<double>{first, last});
558 }
559
560 }
YODA::ScatterND::point
PointND< N > & point(size_t index)
Get a reference to the point with index index.
Definition Scatter.h:362
YODA::ScatterND::Point
PointND< N > Point
Definition Scatter.h:193
YODA::ScatterND::reset
void reset()
Clear all points.
Definition Scatter.h:302

References YODA::ScatterND< N >::addPoint(), YODA::ScatterND< N >::point(), and YODA::ScatterND< N >::reset().

◆ dim()

template<size_t N>
size_t YODA::ScatterND< N >::dim ( ) const
inlinevirtualnoexcept

Dimension of this data object.

Implements YODA::AnalysisObject.

Definition at line 296 of file Scatter.h.

296{ return N; }

◆ edges()

template<size_t N>
std::vector< Pair > YODA::ScatterND< N >::edges ( const size_t  i) const
inline

Definition at line 766 of file Scatter.h.

766 {
767 if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
768 std::vector<Pair> rtn;
769 rtn.resize(numPoints());
770 size_t j = 0;
771 for (const Point& p : points()) {
772 rtn[j++] = std::make_pair(p.min(i), p.max(i));
773 }
774 std::sort(rtn.begin(), rtn.end());
775 rtn.erase(std::unique(rtn.begin(), rtn.end()), rtn.end());
776 return rtn;
777 }
YODA::ScatterND::numPoints
size_t numPoints() const
Number of points in the scatter.
Definition Scatter.h:344

References YODA::ScatterND< N >::numPoints(), and YODA::ScatterND< N >::points().

◆ errAvgs()

template<size_t N>
ValVec YODA::ScatterND< N >::errAvgs ( const size_t  i) const
inline

Get the average error along axis i.

Definition at line 651 of file Scatter.h.

651 {
652 if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
653 ValVec rtn; rtn.reserve(_points.size());
654 for (const auto& pt : _points) {
655 rtn.push_back( pt.errAvg(i) );
656 }
657 return rtn;
658 }

Referenced by YODA::ScatterND< N >::xErrAvgs(), YODA::ScatterND< N >::yErrAvgs(), and YODA::ScatterND< N >::zErrAvgs().

◆ errs()

template<size_t N>
PairVec YODA::ScatterND< N >::errs ( const size_t  i) const
inline

Get the error pairs along axis i.

Definition at line 641 of file Scatter.h.

641 {
642 if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
643 PairVec rtn; rtn.reserve(_points.size());
644 for (const auto& pt : _points) {
645 rtn.push_back( pt.errs(i) );
646 }
647 return rtn;
648 }

Referenced by YODA::ScatterND< N >::xErrs(), YODA::ScatterND< N >::yErrs(), and YODA::ScatterND< N >::zErrs().

◆ lengthContent()

template<size_t N>
size_t YODA::ScatterND< N >::lengthContent ( bool  fixed_length = false) const
inlinevirtualnoexcept

Length of serialized content vector for MPI reduce operations.

Implements YODA::AnalysisObject.

Definition at line 525 of file Scatter.h.

525 {
526 if (fixed_length) return 0;
527 return numPoints() * Point::DataSize::value;
528 }

References YODA::ScatterND< N >::numPoints().

◆ max()

template<size_t N>
double YODA::ScatterND< N >::max ( const size_t  i) const
inline

Get the largest central value along axis i.

Definition at line 634 of file Scatter.h.

634 {
635 if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
636 const ValVec cvals = vals(i);
637 return *std::max_element(cvals.begin(), cvals.end());
638 }
YODA::ScatterND::vals
ValVec vals(const size_t i) const
Get the coordinate vector along axis i.
Definition Scatter.h:597

References YODA::ScatterND< N >::vals().

Referenced by YODA::ScatterND< N >::xMax(), YODA::ScatterND< N >::yMax(), and YODA::ScatterND< N >::zMax().

◆ maxs()

template<size_t N>
ValVec YODA::ScatterND< N >::maxs ( const size_t  i) const
inline

Get the positive error vector along axis i.

Definition at line 617 of file Scatter.h.

617 {
618 if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
619 ValVec rtn; rtn.reserve(_points.size());
620 for (const auto& pt : _points) {
621 rtn.push_back( pt.max(i) );
622 }
623 return rtn;
624 }

Referenced by YODA::ScatterND< N >::xMaxs(), YODA::ScatterND< N >::yMaxs(), and YODA::ScatterND< N >::zMaxs().

◆ min()

template<size_t N>
double YODA::ScatterND< N >::min ( const size_t  i) const
inline

Get the smallest central value along axis i.

Definition at line 627 of file Scatter.h.

627 {
628 if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
629 const ValVec cvals = vals(i);
630 return *std::min_element(cvals.begin(), cvals.end());
631 }

References YODA::ScatterND< N >::vals().

Referenced by YODA::ScatterND< N >::xMin(), YODA::ScatterND< N >::yMin(), and YODA::ScatterND< N >::zMin().

◆ mins()

template<size_t N>
ValVec YODA::ScatterND< N >::mins ( const size_t  i) const
inline

Get the lowest value vector along axis i.

Definition at line 607 of file Scatter.h.

607 {
608 if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
609 ValVec rtn; rtn.reserve(_points.size());
610 for (const auto& pt : _points) {
611 rtn.push_back( pt.min(i) );
612 }
613 return rtn;
614 }

Referenced by YODA::ScatterND< N >::xMins(), YODA::ScatterND< N >::yMins(), and YODA::ScatterND< N >::zMins().

◆ newclone()

template<size_t N>
ScatterND< N > * YODA::ScatterND< N >::newclone ( ) const
inlinevirtual

Make a copy on the heap, via 'new'.

Implements YODA::AnalysisObject.

Definition at line 289 of file Scatter.h.

289 {
290 return new ScatterND<N>(*this);
291 }

◆ numPoints()

template<size_t N>
size_t YODA::ScatterND< N >::numPoints ( ) const
inlinevirtual

Number of points in the scatter.

Implements YODA::Scatter.

Definition at line 344 of file Scatter.h.

344 {
345 return _points.size();
346 }

Referenced by YODA::ScatterND< N >::edges(), YODA::ScatterND< N >::lengthContent(), and YODA::ScatterND< N >::serializeContent().

◆ operator=() [1/2]

template<size_t N>
ScatterND< N > & YODA::ScatterND< N >::operator= ( const ScatterND< N > &  s)
inline

Assignment operator.

Definition at line 266 of file Scatter.h.

266 {
267 if (this != &s) {
268 AnalysisObject::operator = (s);
269 _points = s._points;
270 }
271 return *this;
272 }
YODA::AnalysisObject::operator=
virtual AnalysisObject & operator=(const AnalysisObject &ao) noexcept
Default copy assignment operator.
Definition AnalysisObject.h:61

References YODA::AnalysisObject::operator=().

◆ operator=() [2/2]

template<size_t N>
ScatterND< N > & YODA::ScatterND< N >::operator= ( ScatterND< N > &&  s)
inline

Move operator.

Definition at line 275 of file Scatter.h.

275 {
276 if (this != &s) {
277 AnalysisObject::operator = (s);
278 _points = std::move(s._points);
279 }
280 return *this;
281 }

References YODA::AnalysisObject::operator=().

◆ point() [1/2]

template<size_t N>
PointND< N > & YODA::ScatterND< N >::point ( size_t  index)
inline

Get a reference to the point with index index.

Definition at line 362 of file Scatter.h.

362 {
363 return _points.at(index);
364 }

Referenced by YODA::ScatterND< N >::deserializeContent(), YODA::DbnStorage< DbnN, AxisT >::mkScatter(), and YODA::ScatterND< N >::serializeContent().

◆ point() [2/2]

template<size_t N>
const PointND< N > & YODA::ScatterND< N >::point ( size_t  index) const
inline

Get the point with index index (const version)

Definition at line 368 of file Scatter.h.

368 {
369 return _points.at(index);
370 }

◆ points() [1/2]

template<size_t N>
Points & YODA::ScatterND< N >::points ( )
inline

Get the collection of points.

Definition at line 350 of file Scatter.h.

350 {
351 return _points;
352 }

Referenced by YODA::ScatterND< N >::combineWith(), YODA::ScatterND< N >::edges(), YODA::transform(), YODA::WriterYODA1::writeScatter1D(), YODA::WriterYODA1::writeScatter2D(), and YODA::WriterYODA1::writeScatter3D().

◆ points() [2/2]

template<size_t N>
const Points & YODA::ScatterND< N >::points ( ) const
inline

Get the collection of points (const version)

Definition at line 356 of file Scatter.h.

356 {
357 return _points;
358 }

◆ reset()

template<size_t N>
void YODA::ScatterND< N >::reset ( )
inlinevirtual

Clear all points.

Implements YODA::AnalysisObject.

Definition at line 302 of file Scatter.h.

302 {
303 _points.clear();
304 }

Referenced by YODA::ScatterND< N >::deserializeContent().

◆ rmPoint()

template<size_t N>
void YODA::ScatterND< N >::rmPoint ( size_t  index)
inlinevirtual

Remove the point with index index.

Implements YODA::Scatter.

Definition at line 516 of file Scatter.h.

516 {
517 _points.erase(_points.begin()+index);
518 }

◆ scale() [1/3]

template<size_t N>
void YODA::ScatterND< N >::scale ( const NdVal &  scales)
inline

Scaling.

Definition at line 307 of file Scatter.h.

307 {
308 for (PointND<N>& p : _points) p.scale(scales);
309 }
YODA::ScatterND::scale
void scale(const NdVal &scales)
Scaling.
Definition Scatter.h:307

◆ scale() [2/3]

template<size_t N>
void YODA::ScatterND< N >::scale ( const size_t  i,
double  factor 
)
inline

Scale value and error along direction i.

Definition at line 317 of file Scatter.h.

317 {
318 if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
319 for (PointND<N>& p : _points) p.scale(i, factor);
320 }

◆ scale() [3/3]

template<size_t N>
void YODA::ScatterND< N >::scale ( const std::vector< double > &  scales)
inline

Definition at line 311 of file Scatter.h.

311 {
312 if (scales.size() != N) throw RangeError("Expected " + std::to_string(N) + " scale factors");
313 for (PointND<N>& p : _points) p.scale(scales);
314 }

◆ scaleErr()

template<size_t N>
void YODA::ScatterND< N >::scaleErr ( const size_t  i,
double  factor 
)
inline

Scale error along direction i.

Definition at line 329 of file Scatter.h.

329 {
330 if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
331 for (PointND<N>& p : _points) p.scaleErr(i, factor);
332 }
YODA::ScatterND::scaleErr
void scaleErr(const size_t i, double factor)
Scale error along direction i.
Definition Scatter.h:329

◆ scaleVal()

template<size_t N>
void YODA::ScatterND< N >::scaleVal ( const size_t  i,
double  factor 
)
inline

Scale value along direction i.

Definition at line 323 of file Scatter.h.

323 {
324 if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
325 for (PointND<N>& p : _points) p.scaleVal(i, factor);
326 }
YODA::ScatterND::scaleVal
void scaleVal(const size_t i, double factor)
Scale value along direction i.
Definition Scatter.h:323

◆ serializeContent()

template<size_t N>
std::vector< double > YODA::ScatterND< N >::serializeContent ( bool  fixed_length = false) const
inlinevirtualnoexcept

Content serialisation for MPI reduce operations.

Implements YODA::AnalysisObject.

Definition at line 530 of file Scatter.h.

530 {
531
532 if (fixed_length) return { }; // cannot guarantee fixed length
533
534 std::vector<double> rtn;
535 rtn.reserve(numPoints() * Point::DataSize::value);
536 for (size_t i = 0; i < numPoints(); ++i) {
537 std::vector<double> pdata = point(i)._serializeContent();
538 rtn.insert(std::end(rtn),
539 std::make_move_iterator(std::begin(pdata)),
540 std::make_move_iterator(std::end(pdata)));
541 }
542 return rtn;
543 }

References YODA::ScatterND< N >::numPoints(), and YODA::ScatterND< N >::point().

◆ vals()

template<size_t N>
ValVec YODA::ScatterND< N >::vals ( const size_t  i) const
inline

Get the coordinate vector along axis i.

Definition at line 597 of file Scatter.h.

597 {
598 if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
599 ValVec rtn; rtn.reserve(_points.size());
600 for (const auto& pt : _points) {
601 rtn.push_back( pt.val(i) );
602 }
603 return rtn;
604 }

Referenced by YODA::ScatterND< N >::max(), YODA::ScatterND< N >::min(), YODA::ScatterND< N >::xVals(), YODA::ScatterND< N >::yVals(), and YODA::ScatterND< N >::zVals().

◆ xErrAvgs()

template<size_t N>
ValVec YODA::ScatterND< N >::xErrAvgs ( ) const
inline

Axis-specific alias.

Definition at line 727 of file Scatter.h.

727{ return errAvgs(0); }
YODA::ScatterND::errAvgs
ValVec errAvgs(const size_t i) const
Get the average error along axis i.
Definition Scatter.h:651

References YODA::ScatterND< N >::errAvgs().

◆ xErrs()

template<size_t N>
PairVec YODA::ScatterND< N >::xErrs ( ) const
inline

Axis-specific alias.

Definition at line 716 of file Scatter.h.

716{ return errs(0); }
YODA::ScatterND::errs
PairVec errs(const size_t i) const
Get the error pairs along axis i.
Definition Scatter.h:641

References YODA::ScatterND< N >::errs().

◆ xMax()

template<size_t N>
double YODA::ScatterND< N >::xMax ( ) const
inline

Axis-specific alias.

Definition at line 705 of file Scatter.h.

705{ return max(0); }
YODA::ScatterND::max
double max(const size_t i) const
Get the largest central value along axis i.
Definition Scatter.h:634

References YODA::ScatterND< N >::max().

◆ xMaxs()

template<size_t N>
ValVec YODA::ScatterND< N >::xMaxs ( ) const
inline

Axis-specific alias.

Definition at line 683 of file Scatter.h.

683{ return maxs(0); }
YODA::ScatterND::maxs
ValVec maxs(const size_t i) const
Get the positive error vector along axis i.
Definition Scatter.h:617

References YODA::ScatterND< N >::maxs().

◆ xMin()

template<size_t N>
double YODA::ScatterND< N >::xMin ( ) const
inline

Axis-specific alias.

Definition at line 694 of file Scatter.h.

694{ return min(0); }
YODA::ScatterND::min
double min(const size_t i) const
Get the smallest central value along axis i.
Definition Scatter.h:627

References YODA::ScatterND< N >::min().

◆ xMins()

template<size_t N>
ValVec YODA::ScatterND< N >::xMins ( ) const
inline

Axis-specific alias.

Definition at line 672 of file Scatter.h.

672{ return mins(0); }
YODA::ScatterND::mins
ValVec mins(const size_t i) const
Get the lowest value vector along axis i.
Definition Scatter.h:607

References YODA::ScatterND< N >::mins().

◆ xVals()

template<size_t N>
ValVec YODA::ScatterND< N >::xVals ( ) const
inline

Axis-specific alias.

Definition at line 661 of file Scatter.h.

661{ return vals(0); }

References YODA::ScatterND< N >::vals().

◆ yErrAvgs()

template<size_t N>
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 2)>>
ValVec YODA::ScatterND< N >::yErrAvgs ( ) const
inline

Axis-specific alias.

Definition at line 731 of file Scatter.h.

731{ return errAvgs(1); }

References YODA::ScatterND< N >::errAvgs().

◆ yErrs()

template<size_t N>
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 2)>>
PairVec YODA::ScatterND< N >::yErrs ( ) const
inline

Axis-specific alias.

Definition at line 720 of file Scatter.h.

720{ return errs(1); }

References YODA::ScatterND< N >::errs().

◆ yMax()

template<size_t N>
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 2)>>
double YODA::ScatterND< N >::yMax ( ) const
inline

Axis-specific alias.

Definition at line 709 of file Scatter.h.

709{ return max(1); }

References YODA::ScatterND< N >::max().

◆ yMaxs()

template<size_t N>
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 2)>>
ValVec YODA::ScatterND< N >::yMaxs ( ) const
inline

Axis-specific alias.

Definition at line 687 of file Scatter.h.

687{ return maxs(1); }

References YODA::ScatterND< N >::maxs().

◆ yMin()

template<size_t N>
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 2)>>
double YODA::ScatterND< N >::yMin ( ) const
inline

Axis-specific alias.

Definition at line 698 of file Scatter.h.

698{ return min(1); }

References YODA::ScatterND< N >::min().

◆ yMins()

template<size_t N>
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 2)>>
ValVec YODA::ScatterND< N >::yMins ( ) const
inline

Axis-specific alias.

Definition at line 676 of file Scatter.h.

676{ return mins(1); }

References YODA::ScatterND< N >::mins().

◆ yVals()

template<size_t N>
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 2)>>
ValVec YODA::ScatterND< N >::yVals ( ) const
inline

Axis-specific alias.

Definition at line 665 of file Scatter.h.

665{ return vals(1); }

References YODA::ScatterND< N >::vals().

◆ zErrAvgs()

template<size_t N>
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 3)>>
ValVec YODA::ScatterND< N >::zErrAvgs ( ) const
inline

Axis-specific alias.

Definition at line 735 of file Scatter.h.

735{ return errAvgs(2); }

References YODA::ScatterND< N >::errAvgs().

◆ zErrs()

template<size_t N>
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 3)>>
PairVec YODA::ScatterND< N >::zErrs ( ) const
inline

Axis-specific alias.

Definition at line 724 of file Scatter.h.

724{ return errs(2); }

References YODA::ScatterND< N >::errs().

◆ zMax()

template<size_t N>
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 3)>>
double YODA::ScatterND< N >::zMax ( ) const
inline

Axis-specific alias.

Definition at line 713 of file Scatter.h.

713{ return max(2); }

References YODA::ScatterND< N >::max().

◆ zMaxs()

template<size_t N>
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 3)>>
ValVec YODA::ScatterND< N >::zMaxs ( ) const
inline

Axis-specific alias.

Definition at line 691 of file Scatter.h.

691{ return maxs(2); }

References YODA::ScatterND< N >::maxs().

◆ zMin()

template<size_t N>
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 3)>>
double YODA::ScatterND< N >::zMin ( ) const
inline

Axis-specific alias.

Definition at line 702 of file Scatter.h.

702{ return min(2); }

References YODA::ScatterND< N >::min().

◆ zMins()

template<size_t N>
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 3)>>
ValVec YODA::ScatterND< N >::zMins ( ) const
inline

Axis-specific alias.

Definition at line 680 of file Scatter.h.

680{ return mins(2); }

References YODA::ScatterND< N >::mins().

◆ zVals()

template<size_t N>
template<size_t axisN = N, typename = std::enable_if_t<(axisN >= 3)>>
ValVec YODA::ScatterND< N >::zVals ( ) const
inline

Axis-specific alias.

Definition at line 669 of file Scatter.h.

669{ return vals(2); }

References YODA::ScatterND< N >::vals().

The documentation for this class was generated from the following file:
Generated on Mon Oct 28 2024 13:47:24 for YODA - Yet more Objects for Data Analysis by doxygen 1.9.8