LOST  0.0.1
LOST: Open-source Star Tracker
lost::PairDistanceInvolvingIterator Class Reference

Given a list of star pairs, finds all those pairs which involve a certain star. More...

Public Member Functions

 PairDistanceInvolvingIterator ()
 Create a "past-the-end" iterator. More...
 
 PairDistanceInvolvingIterator (const int16_t *pairs, const int16_t *end, int16_t involving)
 The main constructor. More...
 
PairDistanceInvolvingIteratoroperator++ ()
 Move to the next matching pair. More...
 
int16_t operator* () const
 Access the curent pair. More...
 
bool HasValue ()
 Whether the iterator is currently on a value. (false if iteration is complete) More...
 

Detailed Description

Given a list of star pairs, finds all those pairs which involve a certain star.

Here "involve" means that one of the two stars in the pair is the given star.

Definition at line 169 of file star-id.cpp.

Constructor & Destructor Documentation

◆ PairDistanceInvolvingIterator() [1/2]

lost::PairDistanceInvolvingIterator::PairDistanceInvolvingIterator ( )
inline

Create a "past-the-end" iterator.

If another PairDistanceInvolvingIterator is equal to this, then it is done iterating.

Definition at line 175 of file star-id.cpp.

◆ PairDistanceInvolvingIterator() [2/2]

lost::PairDistanceInvolvingIterator::PairDistanceInvolvingIterator ( const int16_t *  pairs,
const int16_t *  end,
int16_t  involving 
)
inline

The main constructor.

Parameters
pairsStart of an array of star pairs
end"past-the-end" pointer for pairs
Thecatalog index that we want to be involved in the outputted pairs.

Definition at line 184 of file star-id.cpp.

Member Function Documentation

◆ HasValue()

bool lost::PairDistanceInvolvingIterator::HasValue ( )
inline

Whether the iterator is currently on a value. (false if iteration is complete)

Definition at line 211 of file star-id.cpp.

Here is the caller graph for this function:

◆ operator*()

int16_t lost::PairDistanceInvolvingIterator::operator* ( ) const
inline

Access the curent pair.

Definition at line 206 of file star-id.cpp.

◆ operator++()

PairDistanceInvolvingIterator& lost::PairDistanceInvolvingIterator::operator++ ( )
inline

Move to the next matching pair.

Definition at line 198 of file star-id.cpp.

Here is the call graph for this function:

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