DLoopDetector::TemplatedLoopDetector< TDescriptor, F >::tIsland Struct Reference

Matching island. More...

#include <TemplatedLoopDetector.h>

List of all members.

Public Member Functions

 tIsland ()
 tIsland (EntryId f, EntryId l)
 tIsland (EntryId f, EntryId l, double s)
bool operator< (const tIsland &b) const
bool operator> (const tIsland &b) const
int length () const
std::string toString () const

Static Public Member Functions

static bool gt (const tIsland &a, const tIsland &b)
static bool ltId (const tIsland &a, const tIsland &b)

Public Attributes

EntryId first
 Island starting entry.
EntryId last
 Island ending entry.
double score
 Island score.
EntryId best_entry
 Entry of the island with the highest score.
double best_score
 Highest single score in the island.

Detailed Description

template<class TDescriptor, class F>
struct DLoopDetector::TemplatedLoopDetector< TDescriptor, F >::tIsland

Matching island.


Constructor & Destructor Documentation

template<class TDescriptor , class F >
DLoopDetector::TemplatedLoopDetector< TDescriptor, F >::tIsland::tIsland (  )  [inline]

Creates an empty island

template<class TDescriptor , class F >
DLoopDetector::TemplatedLoopDetector< TDescriptor, F >::tIsland::tIsland ( EntryId  f,
EntryId  l 
) [inline]

Creates an island

Parameters:
f first entry
l last entry
template<class TDescriptor , class F >
DLoopDetector::TemplatedLoopDetector< TDescriptor, F >::tIsland::tIsland ( EntryId  f,
EntryId  l,
double  s 
) [inline]

Creates an island

Parameters:
f first entry
l last entry
s island score

Member Function Documentation

template<class TDescriptor , class F >
static bool DLoopDetector::TemplatedLoopDetector< TDescriptor, F >::tIsland::gt ( const tIsland a,
const tIsland b 
) [inline, static]

Returns true iff a > b This function is used to sort in descending order

Parameters:
a 
b 
Returns:
a > b
template<class TDescriptor , class F >
int DLoopDetector::TemplatedLoopDetector< TDescriptor, F >::tIsland::length (  )  const [inline]

Returns the length of the island

Returns:
length of island
template<class TDescriptor , class F >
static bool DLoopDetector::TemplatedLoopDetector< TDescriptor, F >::tIsland::ltId ( const tIsland a,
const tIsland b 
) [inline, static]

Returns true iff entry ids of a are less then those of b. Assumes there is no overlap between the islands

Parameters:
a 
b 
Returns:
a.first < b.first
template<class TDescriptor , class F >
bool DLoopDetector::TemplatedLoopDetector< TDescriptor, F >::tIsland::operator< ( const tIsland b  )  const [inline]

Says whether this score is less than the score of another island

Parameters:
b 
Returns:
true iff this score < b.score
template<class TDescriptor , class F >
bool DLoopDetector::TemplatedLoopDetector< TDescriptor, F >::tIsland::operator> ( const tIsland b  )  const [inline]

Says whether this score is greater than the score of another island

Parameters:
b 
Returns:
true iff this score > b.score
template<class TDescriptor , class F >
std::string DLoopDetector::TemplatedLoopDetector< TDescriptor, F >::tIsland::toString (  )  const [inline]

Returns a printable version of the island

Returns:
printable island

The documentation for this struct was generated from the following file:
 All Classes Namespaces Functions Variables Enumerations Enumerator
Generated on Thu Feb 7 19:29:55 2013 by  doxygen 1.6.3