Implements some methods of Distribution in a manner suitable for distributions storing each observation on one and only one process. More...

#include <NonoverlappingDistribution.h>

Inheritance diagram for ioda::NonoverlappingDistribution:

[legend]

Collaboration diagram for ioda::NonoverlappingDistribution:

[legend]

Public Member Functions
	NonoverlappingDistribution (const eckit::mpi::Comm &Comm)

	~NonoverlappingDistribution () override

bool	isNonoverlapping () const override
	Returns true if the distribution does not assign any record to more than one PE, false otherwise. More...

void	assignRecord (const std::size_t RecNum, const std::size_t LocNum, const eckit::geometry::Point2 &point) override
	If the record `RecNum` has not yet been assigned to a PE, assigns it to the appropriate PE. More...

void	patchObs (std::vector< bool > &patchObsVec) const override
	Sets each element of the provided vector to true if the corresponding location is a "patch obs", i.e. More...

void	computePatchLocs () override
	If necessary, identifies locations of "patch obs", i.e. More...

void	min (int &x) const override
	Calculates the global minimum (over all locations on all PEs) of a location-dependent quantity. More...

void	min (std::size_t &x) const override

void	min (float &x) const override

void	min (double &x) const override

void	min (std::vector< int > &x) const override
	Calculates the global minima (over all locations on all PEs) of multiple location-dependent quantities. More...

void	min (std::vector< std::size_t > &x) const override

void	min (std::vector< float > &x) const override

void	min (std::vector< double > &x) const override

void	max (int &x) const override
	Calculates the global maximum (over all locations on all PEs) of a location-dependent quantity. More...

void	max (std::size_t &x) const override

void	max (float &x) const override

void	max (double &x) const override

void	max (std::vector< int > &x) const override
	Calculates the global maxima (over all locations on all PEs) of multiple location-dependent quantities. More...

void	max (std::vector< std::size_t > &x) const override

void	max (std::vector< float > &x) const override

void	max (std::vector< double > &x) const override

void	allGatherv (std::vector< size_t > &x) const override
	Gather observation data from all processes and deliver the combined data to all processes. More...

void	allGatherv (std::vector< int > &x) const override

void	allGatherv (std::vector< float > &x) const override

void	allGatherv (std::vector< double > &x) const override

void	allGatherv (std::vector< util::DateTime > &x) const override

void	allGatherv (std::vector< std::string > &x) const override

size_t	globalUniqueConsecutiveLocationIndex (size_t loc) const override
	Map the index of a location held on the calling process to the index of the corresponding element of any vector produced by allGatherv(). More...

Public Member Functions inherited from ioda::Distribution
	Distribution (const eckit::mpi::Comm &Comm)

virtual	~Distribution ()

virtual bool	isIdentity () const
	Returns true if the distribution assigns all records to all PEs, false otherwise. More...

virtual bool	isMyRecord (std::size_t RecNum) const =0
	Returns true if record `RecNum` has been assigned to the calling PE during a previous call to assignRecord(). More...

template<typename T >
std::unique_ptr< Accumulator< T > >	createAccumulator () const
	Create an object that can be used to calculate the sum of a location-dependent quantity over locations held on all PEs, each taken into account only once even if it's held on multiple PEs. More...

template<typename T >
std::unique_ptr< Accumulator< std::vector< T > > >	createAccumulator (std::size_t n) const
	Create an object that can be used to calculate the sums of `n` location-dependent quantities over locations held on all PEs, each taken into account only once even if it's held on multiple PEs. More...

virtual std::string	name () const =0

size_t	rank () const
	Accessor to MPI rank. More...

Private Member Functions
template<typename T >
void	minImpl (T &x) const

template<typename T >
void	maxImpl (T &x) const

template<typename T >
void	reductionImpl (T &x, eckit::mpi::Operation::Code op) const

template<typename T >
void	reductionImpl (std::vector< T > &x, eckit::mpi::Operation::Code op) const

std::unique_ptr< Accumulator< int > >	createAccumulatorImpl (int init) const override
	Create an object that can be used to calculate the sum of a location-dependent quantity over locations held on all PEs, each taken into account only once even if it's held on multiple PEs. More...

std::unique_ptr< Accumulator< std::size_t > >	createAccumulatorImpl (std::size_t init) const override

std::unique_ptr< Accumulator< float > >	createAccumulatorImpl (float init) const override

std::unique_ptr< Accumulator< double > >	createAccumulatorImpl (double init) const override

std::unique_ptr< Accumulator< std::vector< int > > >	createAccumulatorImpl (const std::vector< int > &init) const override
	Create an object that can be used to calculate the sums of multiple location-dependent quantities over locations held on all PEs, each taken into account only once even if it's held on multiple PEs. More...

std::unique_ptr< Accumulator< std::vector< std::size_t > > >	createAccumulatorImpl (const std::vector< std::size_t > &init) const override

std::unique_ptr< Accumulator< std::vector< float > > >	createAccumulatorImpl (const std::vector< float > &init) const override

std::unique_ptr< Accumulator< std::vector< double > > >	createAccumulatorImpl (const std::vector< double > &init) const override

template<typename T >
std::unique_ptr< Accumulator< T > >	createAccumulatorImplT (const T &init) const

Private Attributes
size_t	numLocationsOnThisRank_ = 0

size_t	numLocationsOnLowerRanks_ = 0

Additional Inherited Members
Protected Attributes inherited from ioda::Distribution
const eckit::mpi::Comm &	comm_
	Local MPI communicator. More...

Related Functions inherited from ioda::Distribution
double	dotProduct (const Distribution &dist, std::size_t numVariables, const std::vector< double > &v1, const std::vector< double > &v2)
	Computes the dot product between two vectors of obs distributed across MPI ranks. More...

std::size_t	globalNumNonMissingObs (const Distribution &dist, size_t numVariables, const std::vector< double > &v)
	Counts unique non-missing observations in a vector. More...

Detailed Description

Implements some methods of Distribution in a manner suitable for distributions storing each observation on one and only one process.

Definition at line 25 of file NonoverlappingDistribution.h.

Constructor & Destructor Documentation

◆ NonoverlappingDistribution()

ioda::NonoverlappingDistribution::NonoverlappingDistribution ( const eckit::mpi::Comm & Comm )

explicit

Definition at line 26 of file NonoverlappingDistribution.cc.

◆ ~NonoverlappingDistribution()

ioda::NonoverlappingDistribution::~NonoverlappingDistribution ( )

override

Definition at line 32 of file NonoverlappingDistribution.cc.

Member Function Documentation

◆ allGatherv() [1/6]

void ioda::NonoverlappingDistribution::allGatherv ( std::vector< double > & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 206 of file NonoverlappingDistribution.cc.

◆ allGatherv() [2/6]

void ioda::NonoverlappingDistribution::allGatherv ( std::vector< float > & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 201 of file NonoverlappingDistribution.cc.

◆ allGatherv() [3/6]

void ioda::NonoverlappingDistribution::allGatherv ( std::vector< int > & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 196 of file NonoverlappingDistribution.cc.

◆ allGatherv() [4/6]

void ioda::NonoverlappingDistribution::allGatherv ( std::vector< size_t > & x ) const

overridevirtual

Gather observation data from all processes and deliver the combined data to all processes.

Parameters

[in,out] x On input: a vector whose ith element is associated with the ith observation held by the calling process. On output: a concatenation of the vectors x passed by all calling processes, with duplicates removed (i.e. if any observations are duplicated across multiple processes, the elements of x corresponding to these data are included only once).

Implements ioda::Distribution.

Definition at line 191 of file NonoverlappingDistribution.cc.

◆ allGatherv() [5/6]

void ioda::NonoverlappingDistribution::allGatherv ( std::vector< std::string > & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 216 of file NonoverlappingDistribution.cc.

◆ allGatherv() [6/6]

void ioda::NonoverlappingDistribution::allGatherv ( std::vector< util::DateTime > & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 211 of file NonoverlappingDistribution.cc.

◆ assignRecord()

void ioda::NonoverlappingDistribution::assignRecord	(	const std::size_t	RecNum,
		const std::size_t	LocNum,
		const eckit::geometry::Point2 &	point
	)

overridevirtual

If the record RecNum has not yet been assigned to a PE, assigns it to the appropriate PE.

Informs the distribution that location LocNum belongs to this record.

Parameters

RecNum	Record containing the location `LocNum`.
LocNum	(Global) location index.
point	Latitude and longitude of this location.

Reimplemented from ioda::Distribution.

Definition at line 37 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computePatchLocs()

void ioda::NonoverlappingDistribution::computePatchLocs ( )

overridevirtual

If necessary, identifies locations of "patch obs", i.e.

locations belonging to records owned by this PE.

This function must be called when all records have been assigned, and in particular before any calls to the createAccumulator() and globalUniqueConsecutiveLocationIndex() member functions or the global functions and dotProduct(), globalNumNonMissingObs().

Reimplemented from ioda::Distribution.

Definition at line 45 of file NonoverlappingDistribution.cc.

◆ createAccumulatorImpl() [1/8]

std::unique_ptr< Accumulator< std::vector< double > > > ioda::NonoverlappingDistribution::createAccumulatorImpl ( const std::vector< double > & init ) const

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 180 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ createAccumulatorImpl() [2/8]

std::unique_ptr< Accumulator< std::vector< float > > > ioda::NonoverlappingDistribution::createAccumulatorImpl ( const std::vector< float > & init ) const

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 175 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ createAccumulatorImpl() [3/8]

std::unique_ptr< Accumulator< std::vector< int > > > ioda::NonoverlappingDistribution::createAccumulatorImpl ( const std::vector< int > & init ) const

overrideprivatevirtual

Create an object that can be used to calculate the sums of multiple location-dependent quantities over locations held on all PEs, each taken into account only once even if it's held on multiple PEs.

Parameters

init	A vector of as many elements as there are sums to calculate. The values of these elements are ignored.

Implements ioda::Distribution.

Definition at line 165 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ createAccumulatorImpl() [4/8]

std::unique_ptr< Accumulator< std::vector< std::size_t > > > ioda::NonoverlappingDistribution::createAccumulatorImpl ( const std::vector< std::size_t > & init ) const

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 170 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ createAccumulatorImpl() [5/8]

std::unique_ptr< Accumulator< double > > ioda::NonoverlappingDistribution::createAccumulatorImpl ( double init ) const

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 160 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ createAccumulatorImpl() [6/8]

std::unique_ptr< Accumulator< float > > ioda::NonoverlappingDistribution::createAccumulatorImpl ( float init ) const

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 155 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ createAccumulatorImpl() [7/8]

std::unique_ptr< Accumulator< int > > ioda::NonoverlappingDistribution::createAccumulatorImpl ( int init ) const

overrideprivatevirtual

Create an object that can be used to calculate the sum of a location-dependent quantity over locations held on all PEs, each taken into account only once even if it's held on multiple PEs.

Parameters

init	Used only to select the right overload – the value is ignored.

Implements ioda::Distribution.

Definition at line 145 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ createAccumulatorImpl() [8/8]

std::unique_ptr< Accumulator< std::size_t > > ioda::NonoverlappingDistribution::createAccumulatorImpl ( std::size_t init ) const

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 150 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ createAccumulatorImplT()

template<typename T >

std::unique_ptr< Accumulator< T > > ioda::NonoverlappingDistribution::createAccumulatorImplT ( const T & init ) const

private

Definition at line 186 of file NonoverlappingDistribution.cc.

Here is the caller graph for this function:

◆ globalUniqueConsecutiveLocationIndex()

size_t ioda::NonoverlappingDistribution::globalUniqueConsecutiveLocationIndex ( size_t loc ) const

overridevirtual

Map the index of a location held on the calling process to the index of the corresponding element of any vector produced by allGatherv().

Implements ioda::Distribution.

Definition at line 221 of file NonoverlappingDistribution.cc.

◆ isNonoverlapping()

bool ioda::NonoverlappingDistribution::isNonoverlapping ( ) const

inlineoverridevirtual

Returns true if the distribution does not assign any record to more than one PE, false otherwise.

Reimplemented from ioda::Distribution.

Definition at line 30 of file NonoverlappingDistribution.h.

◆ max() [1/8]

void ioda::NonoverlappingDistribution::max ( double & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 106 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ max() [2/8]

void ioda::NonoverlappingDistribution::max ( float & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 102 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ max() [3/8]

void ioda::NonoverlappingDistribution::max ( int & x ) const

overridevirtual

Calculates the global maximum (over all locations on all PEs) of a location-dependent quantity.

Parameters

[in,out] x On input, the local maximum (over all locations on the current PE) of a location-dependent quantity. On output, its global maximum.

Implements ioda::Distribution.

Definition at line 94 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ max() [4/8]

void ioda::NonoverlappingDistribution::max ( std::size_t & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 98 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ max() [5/8]

void ioda::NonoverlappingDistribution::max ( std::vector< double > & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 122 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ max() [6/8]

void ioda::NonoverlappingDistribution::max ( std::vector< float > & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 118 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ max() [7/8]

void ioda::NonoverlappingDistribution::max ( std::vector< int > & x ) const

overridevirtual

Calculates the global maxima (over all locations on all PEs) of multiple location-dependent quantities.

Parameters

[in,out] x On input, each element of x should be the local maximum (over all locations on the current PE) of a location-dependent quantity. On output, that element will be set to the global maximum of that quantity.

Implements ioda::Distribution.

Definition at line 110 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ max() [8/8]

void ioda::NonoverlappingDistribution::max ( std::vector< std::size_t > & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 114 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ maxImpl()

template<typename T >

void ioda::NonoverlappingDistribution::maxImpl ( T & x ) const

private

Definition at line 127 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ min() [1/8]

void ioda::NonoverlappingDistribution::min ( double & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 68 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ min() [2/8]

void ioda::NonoverlappingDistribution::min ( float & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 64 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ min() [3/8]

void ioda::NonoverlappingDistribution::min ( int & x ) const

overridevirtual

Calculates the global minimum (over all locations on all PEs) of a location-dependent quantity.

Parameters

[in,out] x On input, the local minimum (over all locations on the current PE) of a location-dependent quantity. On output, its global minimum.

Implements ioda::Distribution.

Definition at line 56 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ min() [4/8]

void ioda::NonoverlappingDistribution::min ( std::size_t & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 60 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ min() [5/8]

void ioda::NonoverlappingDistribution::min ( std::vector< double > & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 84 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ min() [6/8]

void ioda::NonoverlappingDistribution::min ( std::vector< float > & x ) const

overridevirtual

Implements ioda::Distribution.

Definition at line 80 of file NonoverlappingDistribution.cc.

Here is the call graph for this function:

◆ min() [7/8]

void ioda::NonoverlappingDistribution::min ( std::vector< int > & x ) const

overridevirtual

Calculates the global minima (over all locations on all PEs) of multiple location-dependent quantities.

Parameters

[in,out] x On input, each element of x should be the local minimum (over all locations on the current PE) of a location-dependent quantity. On output, that element will be set to the global minimum of that quantity.

Implements ioda::Distribution.

Definition at line 72 of file NonoverlappingDistribution.cc.

Here is the call graph for this function: