lsst::ap::ZoneEntryArray< EntryT > Struct Template Reference

Stores entries inside a single zone (a narrow declination stripe) in a sorted array. More...

#include <ZoneTypes.h>

Public Types
typedef EntryT::Chunk	Chunk
typedef EntryT::Data	Data

Public Member Functions
	ZoneEntryArray ()
	~ZoneEntryArray ()
void	init (int const capacity)
void	insert (double const ra, double const dec, Data *const data, Chunk *const chunk, int const index)
void	sort ()
void	grow ()
int	size () const
void	clear ()
int	findLte (boost::uint32_t const ra)
int	findGte (boost::uint32_t const ra) const
void	computeMatchParams (ZoneStripeChunkDecomposition const &zsc, double const radius)
template<typename FilterT >
int	pack (FilterT &filter)
template<typename FunctionT >
void	apply (FunctionT &function)

Public Attributes
EntryT *	_entries
int	_size
int	_capacity
int	_zone
boost::uint32_t	_deltaRa

Detailed Description

template<typename EntryT>
struct lsst::ap::ZoneEntryArray< EntryT >

Stores entries inside a single zone (a narrow declination stripe) in a sorted array.

Definition at line 113 of file ZoneTypes.h.

Member Typedef Documentation

template<typename EntryT >

typedef EntryT::Chunk lsst::ap::ZoneEntryArray< EntryT >::Chunk

Definition at line 114 of file ZoneTypes.h.

template<typename EntryT >

typedef EntryT::Data lsst::ap::ZoneEntryArray< EntryT >::Data

Definition at line 115 of file ZoneTypes.h.

Constructor & Destructor Documentation

template<typename EntryT >

lsst::ap::ZoneEntryArray< EntryT >::ZoneEntryArray

(

)

Definition at line 84 of file ZoneTypes.cc.

    : _entries(0), _size(0), _capacity(0), _zone(0), _deltaRa(0) {}

template<typename EntryT >

lsst::ap::ZoneEntryArray< EntryT >::~ZoneEntryArray

(

)

Definition at line 89 of file ZoneTypes.cc.

                                              {
    if (_entries != 0) {
        std::free(_entries);
        _entries = 0;
    }
}

Member Function Documentation

template<typename EntryT >

template<typename FunctionT >

void lsst::ap::ZoneEntryArray< EntryT >::apply

(

FunctionT &

function

)

Given a functor that implements

void operator()(EntryT const &) 

, applies it to every entry in the zone.

Definition at line 179 of file ZoneTypes.cc.

                                                             {
    for (int i = 0; i < _size; ++i) {
        function(_entries[i]);
    }
}

template<typename EntryT >

void lsst::ap::ZoneEntryArray< EntryT >::clear ( )

inline

Empties the zone (without deallocating/shrinking memory).

Definition at line 146 of file ZoneTypes.h.

{ _size = 0; }

template<typename EntryT >

void lsst::ap::ZoneEntryArray< EntryT >::computeMatchParams	(	ZoneStripeChunkDecomposition const &	zsc,
		double const	radius
	)

Prepares for a distance based match with the given radius

Definition at line 137 of file ZoneTypes.cc.

  {
    double d1 = std::fabs(zsc.getZoneDecMin(_zone));
    double d2 = std::fabs(zsc.getZoneDecMax(_zone));
    _deltaRa  = deltaRaToScaledInteger(maxAlpha(radius, d1 < d2 ? d2 : d1));
}

template<typename EntryT >

int lsst::ap::ZoneEntryArray< EntryT >::findGte ( boost::uint32_t const  ra ) const

inline

Finds the first entry with ra greater than or equal to the specified value.

Definition at line 170 of file ZoneTypes.h.

                                              {
        EntryT const * const entries = _entries;
        int const end = _size;

        int sz = end;
        int i  = 0;

        while (sz > 0) {
            int mid = sz >> 1;
            if (entries[i + mid] < ra) {
                i  += mid + 1;
                sz -= mid + 1;
            } else {
                sz = mid;
            }
        }
        // if no entry was found, wrap to the smallest entry
        return (i == end) ? 0 : i;
    }

template<typename EntryT >

int lsst::ap::ZoneEntryArray< EntryT >::findLte ( boost::uint32_t const  ra )

inline

Finds the last entry with ra less than or equal to the specified value.

Definition at line 149 of file ZoneTypes.h.

                                        {
        EntryT const * const entries = _entries;
        int const last = _size - 1;

        int sz = last + 1;
        int i  = last;

        while (sz > 0) {
            int mid = sz >> 1;
            if (ra < entries[i - mid]) {
                i  -= mid + 1;
                sz -= mid + 1;
            } else {
                sz = mid;
            }
        }
        // if no entry was found, wrap to the largest entry
        return (i < 0) ? last : i;
    }

template<typename EntryT >

void lsst::ap::ZoneEntryArray< EntryT >::grow

(

)

Increases the size of the underlying array of entries by roughly 25% (and by at least 1).

Definition at line 122 of file ZoneTypes.cc.

                                        {
    int cap = _capacity >> 2;
    cap = _capacity + (64 > cap ? 64 : cap);
    EntryT * entries  = static_cast<EntryT *>(std::realloc(_entries, sizeof(EntryT)*cap));
    if (entries == 0) {
        throw LSST_EXCEPT(lsst::pex::exceptions::MemoryError,
                          "failed to increase zone capacity");
    }
    _entries  = entries;
    _capacity = cap;
}

template<typename EntryT >

void lsst::ap::ZoneEntryArray< EntryT >::init

(

int const

capacity

)

Initializes the zone, allocating space for the given number of entries.

Definition at line 99 of file ZoneTypes.cc.

                                                          {
    if (capacity > 0) {
        std::size_t const nb = sizeof(EntryT) * capacity;
        EntryT * entries = static_cast<EntryT *>(std::malloc(nb));
        if (entries == 0) {
            throw LSST_EXCEPT(lsst::pex::exceptions::MemoryError,
                              "failed to allocate zone");
        }
        _entries = entries;
        _capacity = capacity;
    }
}

template<typename EntryT >

void lsst::ap::ZoneEntryArray< EntryT >::insert ( double const  ra, double const  dec, Data *const  data, Chunk *const  chunk, int const  index  )

inline

Inserts the given data item into the zone.

Definition at line 129 of file ZoneTypes.h.

                                                                                                            {
        int const sz = _size;
        if (sz == _capacity) {
            grow();
        }
        new(&_entries[sz]) EntryT(ra, dec, data, chunk, index);
        _size = sz + 1;
    }

template<typename EntryT >

template<typename FilterT >

int lsst::ap::ZoneEntryArray< EntryT >::pack

(

FilterT &

filter

)

Given a functor that implements

bool operator()(EntryT const &) 

, removes any entry e where filter(e) returns false from the zone.

Returns

the number of entries that were removed.

Definition at line 155 of file ZoneTypes.cc.

                                                       {
    int src = 0;
    int dst = 0;

    for ( ; src < _size; ++src) {
        if (!filter(_entries[src])) {
            continue;
        }
        if (dst != src) {
            _entries[dst] = _entries[src];
        }
        ++dst;
    }
    _size = dst;
    return src - dst;
}

template<typename EntryT >

int lsst::ap::ZoneEntryArray< EntryT >::size ( ) const

inline

Returns the number of entries in the zone.

Definition at line 143 of file ZoneTypes.h.

{ return _size; }

template<typename EntryT >

void lsst::ap::ZoneEntryArray< EntryT >::sort

(

)

Sorts the zone entries on ra.

Definition at line 115 of file ZoneTypes.cc.

                                        {
    std::sort(_entries, _entries + _size);
}

Member Data Documentation

template<typename EntryT >

int lsst::ap::ZoneEntryArray< EntryT >::_capacity

Definition at line 119 of file ZoneTypes.h.

template<typename EntryT >

boost::uint32_t lsst::ap::ZoneEntryArray< EntryT >::_deltaRa

Definition at line 121 of file ZoneTypes.h.

template<typename EntryT >

EntryT* lsst::ap::ZoneEntryArray< EntryT >::_entries

Definition at line 117 of file ZoneTypes.h.

template<typename EntryT >

int lsst::ap::ZoneEntryArray< EntryT >::_size

Definition at line 118 of file ZoneTypes.h.

template<typename EntryT >

int lsst::ap::ZoneEntryArray< EntryT >::_zone

Definition at line 120 of file ZoneTypes.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/include/lsst/ap/ZoneTypes.h
• /lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/include/lsst/ap/ZoneTypes.cc