Represents a concatenation of locations and records from two distributions. More...

#include <PairOfDistributions.h>

Inheritance diagram for ioda::PairOfDistributions:

Collaboration diagram for ioda::PairOfDistributions:

Public Member Functions
	PairOfDistributions (const eckit::mpi::Comm &comm, std::shared_ptr< const Distribution > first, std::shared_ptr< const Distribution > second, std::size_t firstNumLocs, std::size_t secondRecordNumOffset)
	Create a PairOfDistributions object. More...

	~PairOfDistributions () override

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

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

void	patchObs (std::vector< bool > &) const override
	Sets each element of the provided vector to true if the corresponding location is a "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...

std::string	name () const override

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	isNonoverlapping () const
	Returns true if the distribution does not assign any record to more than one PE, false otherwise. More...

virtual void	computePatchLocs ()
	If necessary, identifies locations of "patch obs", i.e. 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...

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

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 > >	createScalarAccumulator () const

template<typename T >
std::unique_ptr< Accumulator< std::vector< T > > >	createVectorAccumulator (std::size_t n) const

template<typename T >
void	allGathervImpl (std::vector< T > &x) const

Private Attributes
std::shared_ptr< const Distribution >	first_

std::shared_ptr< const Distribution >	second_

std::size_t	firstNumLocs_

std::size_t	secondRecordNumOffset_

std::size_t	secondGlobalUniqueConsecutiveLocationIndexOffset_

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

Represents a concatenation of locations and records from two distributions.

Definition at line 16 of file PairOfDistributions.h.

Constructor & Destructor Documentation

◆ PairOfDistributions()

ioda::PairOfDistributions::PairOfDistributions	(	const eckit::mpi::Comm &	comm,
		std::shared_ptr< const Distribution >	first,
		std::shared_ptr< const Distribution >	second,
		std::size_t	firstNumLocs,
		std::size_t	secondRecordNumOffset
	)

explicit

Create a PairOfDistributions object.

Parameters

comm	Communicator used by both `first` and `second`.
first	The first distribution.
second	The second distribution.
firstNumLocs	Number of locations in the first distribution held on the calling process. The PairOfDistributions will map locations 0, 1, ..., (`firstNumLocs` - 1) to the same locations from the first distribution, and locations `firstNumLocs`, (`firstNumLocs` + 1), ... to locations 0, 1, ... from the second distribution.
secondRecordNumOffset	Offset to apply to record indices from the second distribution. The PairOfDistributions will map each record `r` < `secondRecordNumOffset` to record `r` from the first distribution, and each record `r` >= `secondRecordNumOffset` to record `r` - `secondRecordNumOffset` from the second distribution.

Definition at line 25 of file PairOfDistributions.cc.

◆ ~PairOfDistributions()

ioda::PairOfDistributions::~PairOfDistributions ( )

override

Definition at line 48 of file PairOfDistributions.cc.

Member Function Documentation

◆ allGatherv() [1/6]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 234 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ allGatherv() [2/6]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 230 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ allGatherv() [3/6]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 226 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ allGatherv() [4/6]

void ioda::PairOfDistributions::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 222 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ allGatherv() [5/6]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 242 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ allGatherv() [6/6]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 238 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ allGathervImpl()

template<typename T >

void ioda::PairOfDistributions::allGathervImpl ( std::vector< T > & x ) const

private

Definition at line 247 of file PairOfDistributions.cc.

Here is the caller graph for this function:

◆ assignRecord()

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

overridevirtual

This function should not be called. Records are meant to be assigned to the two distributions before wrapping them in a PairOfDistributions.

Reimplemented from ioda::Distribution.

Definition at line 53 of file PairOfDistributions.cc.

◆ createAccumulatorImpl() [1/8]

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

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 199 of file PairOfDistributions.cc.

◆ createAccumulatorImpl() [2/8]

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

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 194 of file PairOfDistributions.cc.

◆ createAccumulatorImpl() [3/8]

std::unique_ptr< Accumulator< std::vector< int > > > ioda::PairOfDistributions::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 184 of file PairOfDistributions.cc.

◆ createAccumulatorImpl() [4/8]

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

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 189 of file PairOfDistributions.cc.

◆ createAccumulatorImpl() [5/8]

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

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 179 of file PairOfDistributions.cc.

◆ createAccumulatorImpl() [6/8]

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

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 174 of file PairOfDistributions.cc.

◆ createAccumulatorImpl() [7/8]

std::unique_ptr< Accumulator< int > > ioda::PairOfDistributions::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 164 of file PairOfDistributions.cc.

◆ createAccumulatorImpl() [8/8]

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

overrideprivatevirtual

Implements ioda::Distribution.

Definition at line 169 of file PairOfDistributions.cc.

◆ createScalarAccumulator()

template<typename T >

std::unique_ptr< Accumulator< T > > ioda::PairOfDistributions::createScalarAccumulator

private

Definition at line 205 of file PairOfDistributions.cc.

◆ createVectorAccumulator()

template<typename T >

std::unique_ptr< Accumulator< std::vector< T > > > ioda::PairOfDistributions::createVectorAccumulator ( std::size_t n ) const

private

Definition at line 214 of file PairOfDistributions.cc.

◆ globalUniqueConsecutiveLocationIndex()

size_t ioda::PairOfDistributions::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 258 of file PairOfDistributions.cc.

◆ isMyRecord()

bool ioda::PairOfDistributions::isMyRecord ( std::size_t RecNum ) const

overridevirtual

Returns true if record RecNum has been assigned to the calling PE during a previous call to assignRecord().

Clients can use this function to determine which records to keep when reading in observations.

Implements ioda::Distribution.

Definition at line 61 of file PairOfDistributions.cc.

◆ max() [1/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 136 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ max() [2/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 132 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ max() [3/8]

void ioda::PairOfDistributions::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 124 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ max() [4/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 128 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ max() [5/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 152 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ max() [6/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 148 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ max() [7/8]

void ioda::PairOfDistributions::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 140 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ max() [8/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 144 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ maxImpl()

template<typename T >

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

private

Definition at line 157 of file PairOfDistributions.cc.

Here is the caller graph for this function:

◆ min() [1/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 97 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ min() [2/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 93 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ min() [3/8]

void ioda::PairOfDistributions::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 85 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ min() [4/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 89 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ min() [5/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 113 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ min() [6/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 109 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ min() [7/8]

void ioda::PairOfDistributions::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 101 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ min() [8/8]

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

overridevirtual

Implements ioda::Distribution.

Definition at line 105 of file PairOfDistributions.cc.

Here is the call graph for this function:

◆ minImpl()

template<typename T >

void ioda::PairOfDistributions::minImpl ( T & x ) const

private

Definition at line 118 of file PairOfDistributions.cc.

Here is the caller graph for this function:

◆ name()

std::string ioda::PairOfDistributions::name ( ) const

inlineoverridevirtual

Implements ioda::Distribution.

Definition at line 77 of file PairOfDistributions.h.

Here is the caller graph for this function:

◆ patchObs()

void ioda::PairOfDistributions::patchObs ( std::vector< bool > & isPatchObs ) const

overridevirtual

Sets each element of the provided vector to true if the corresponding location is a "patch obs", i.e.

it belongs to a record owned by this PE, and to false otherwise.

Parameters

isPatchObs Preallocated vector of as many elements as there are locations on this PE.

Implements ioda::Distribution.

Definition at line 69 of file PairOfDistributions.cc.

Member Data Documentation

◆ first_

std::shared_ptr<const Distribution> ioda::PairOfDistributions::first_

private

Definition at line 112 of file PairOfDistributions.h.

◆ firstNumLocs_

std::size_t ioda::PairOfDistributions::firstNumLocs_

private

Definition at line 114 of file PairOfDistributions.h.

◆ second_

std::shared_ptr<const Distribution> ioda::PairOfDistributions::second_

private

Definition at line 113 of file PairOfDistributions.h.

◆ secondGlobalUniqueConsecutiveLocationIndexOffset_

std::size_t ioda::PairOfDistributions::secondGlobalUniqueConsecutiveLocationIndexOffset_

private

Definition at line 116 of file PairOfDistributions.h.

◆ secondRecordNumOffset_

std::size_t ioda::PairOfDistributions::secondRecordNumOffset_

private

Definition at line 115 of file PairOfDistributions.h.

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PairOfDistributions()

◆ ~PairOfDistributions()

Member Function Documentation

◆ allGatherv() [1/6]

◆ allGatherv() [2/6]

◆ allGatherv() [3/6]

◆ allGatherv() [4/6]

◆ allGatherv() [5/6]

◆ allGatherv() [6/6]

◆ allGathervImpl()

◆ assignRecord()

◆ createAccumulatorImpl() [1/8]

◆ createAccumulatorImpl() [2/8]

◆ createAccumulatorImpl() [3/8]

◆ createAccumulatorImpl() [4/8]

◆ createAccumulatorImpl() [5/8]

◆ createAccumulatorImpl() [6/8]

◆ createAccumulatorImpl() [7/8]

◆ createAccumulatorImpl() [8/8]

◆ createScalarAccumulator()

◆ createVectorAccumulator()

◆ globalUniqueConsecutiveLocationIndex()

◆ isMyRecord()

◆ max() [1/8]

◆ max() [2/8]

◆ max() [3/8]

◆ max() [4/8]

◆ max() [5/8]

◆ max() [6/8]

◆ max() [7/8]

◆ max() [8/8]

◆ maxImpl()

◆ min() [1/8]

◆ min() [2/8]

◆ min() [3/8]

◆ min() [4/8]

◆ min() [5/8]

◆ min() [6/8]

◆ min() [7/8]

◆ min() [8/8]

◆ minImpl()

◆ name()

◆ patchObs()

Member Data Documentation

◆ first_

◆ firstNumLocs_

◆ second_

◆ secondGlobalUniqueConsecutiveLocationIndexOffset_

◆ secondRecordNumOffset_