World Ocean Simulation System (WOSS) library
woss::CoordComparator< CompUser, T > Class Template Reference

Function object for partial ordering of coordinates. More...

#include <coordinates-definitions.h>

Collaboration diagram for woss::CoordComparator< CompUser, T >:
Collaboration graph

Public Member Functions

bool operator() (const T &x, const T &y) const
 

Detailed Description

template<class CompUser, class T = Coord>
class woss::CoordComparator< CompUser, T >

Function object for partial ordering of coordinates.

Function object class for partial ordering of two coordinates instances based on great circle distance. The user class has to provide a static method called getSpaceSampling() that returns the threshold distance

Member Function Documentation

◆ operator()()

template<class CompUser , class T = Coord>
bool woss::CoordComparator< CompUser, T >::operator() ( const T &  x,
const T &  y 
) const
inline

Function that compares to T instances. If CompUser::getSpaceSampling() is valid (>=0) two valid T are considered equivalent if their great circle distance is less or equal to the space sampling value

Parameters
txconst reference to a valid T object
rxconst reference to a valid T object
Returns
true if x less than y, false otherwise

References woss::operator<().

Here is the call graph for this function:

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