Aboria

PrevUpHomeNext

Function template chebyshev_search

Aboria::chebyshev_search — returns a search_iterator that iterates over all the particles within a given distance around a point. The user can optionally define a coordinate transform to apply before the search is performed

Synopsis

// In header: </home/travis/build/martinjrobins/Aboria/src/Search.h>


template<typename Query, typename Transform = IdentityTransform, 
         typename SearchIterator = search_iterator<Query, -1, Transform> > 
  SearchIterator 
  chebyshev_search(const Query & query, 
                   const typename Query::double_d & centre, 
                   const double max_distance, 
                   const Transform & transform = Transform());

Description

Uses the chebyshev distance https://en.wikipedia.org/wiki/Chebyshev_distance

Parameters:

centre

the central point of the search

max_distance

the maximum distance to search around centre

query

the query object

transform

a user defined coordinate transform (default: IdentityTransform)

Template Parameters:

Query

the query object type

Transform

type of the user-defined coordinate system transform


PrevUpHomeNext