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

Partial specialization for partial ordering of CoordZ coordinates. More...

#include <coordinates-definitions.h>

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

Public Member Functions

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

Detailed Description

template<class CompUser>
class woss::CoordComparator< CompUser, CoordZ >

Partial specialization for partial ordering of CoordZ coordinates.

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

Member Function Documentation

◆ operator()()

template<class CompUser >
bool woss::CoordComparator< CompUser, CoordZ >::operator() ( const CoordZ x,
const CoordZ y 
) const
inline

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

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

References woss::CoordZ::getCartDistance(), and woss::operator<().

Here is the call graph for this function:

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