group Unbound functions for filtering particles

Unbound functions for filtering particles #

Functions ##

Functions Documentation ##

function ifilter_select ##

Particles & ifilter_select(
    Particles & particles,
    const Cut & c
)

Filter a particle collection in-place to the subset that passes the supplied Cut.

function ifilterBy ##

inline Particles & ifilterBy(
    Particles & particles,
    const Cut & c
)

Deprecated:

Use ifilter_select

Alias for ifilter_select

function iselect ##

inline Particles & iselect(
    Particles & particles,
    const Cut & c
)

New alias for ifilter_select.

function filter_select ##

inline Particles filter_select(
    const Particles & particles,
    const Cut & c
)

Filter a particle collection in-place to the subset that passes the supplied Cut.

function filterBy ##

inline Particles filterBy(
    const Particles & particles,
    const Cut & c
)

Deprecated:

Use filter_select

Alias for ifilter_select

function select ##

inline Particles select(
    const Particles & particles,
    const Cut & c
)

New alias for ifilter_select.

function filter_select ##

inline Particles filter_select(
    const Particles & particles,
    const Cut & c,
    Particles & out
)

Filter a particle collection in-place to the subset that passes the supplied Cut.

function filterBy ##

inline Particles filterBy(
    const Particles & particles,
    const Cut & c,
    Particles & out
)

Deprecated:

Use filter_select

Alias for ifilter_select

function select ##

inline Particles select(
    const Particles & particles,
    const Cut & c,
    Particles & out
)

New alias for ifilter_select.

function ifilter_discard ##

Particles & ifilter_discard(
    Particles & particles,
    const Cut & c
)

Filter a particle collection in-place to the subset that fails the supplied Cut.

function idiscard ##

inline Particles & idiscard(
    Particles & particles,
    const Cut & c
)

New alias for ifilter_discard.

function filter_discard ##

inline Particles filter_discard(
    const Particles & particles,
    const Cut & c
)

Filter a particle collection in-place to the subset that fails the supplied Cut.

function discard ##

inline Particles discard(
    const Particles & particles,
    const Cut & c
)

New alias for filter_discard.

function filter_discard ##

inline Particles filter_discard(
    const Particles & particles,
    const Cut & c,
    Particles & out
)

Filter a particle collection in-place to the subset that fails the supplied Cut.

function discard ##

inline Particles discard(
    const Particles & particles,
    const Cut & c,
    Particles & out
)

New alias for filter_discard.

Updated on 2022-08-07 at 20:17:17 +0100