A simple class to encapsulate data to be cached about ESTs. More...
#include <CachedESTInfo.h>
Public Member Functions | |
| CachedESTInfo () | |
| The default constructor. | |
| CachedESTInfo (const int refESTidxValue, const int estIdxValue, const float metricValue, const int alignmentDataValue, const int directionDataValue) | |
| A convenience all parameter constructor. | |
| ~CachedESTInfo () | |
| The destructor. | |
Public Attributes | |
| int | refESTidx |
| The zero-based index of the reference EST. | |
| int | estIdx |
| The index of the EST for which this data is relevant. | |
| float | metric |
| The distance/similarity metric value. | |
| int | alignmentData |
| The alignment information for this EST. | |
| int | directionData |
| The direction information for this EST. | |
A simple class to encapsulate data to be cached about ESTs.
This class represents the final (atomic) entry in the MSTCache data structure. This class is meant to serve just as an encapsulation class. Consequently, it is very straightfoward and exposes all the fields in it directly.
Definition at line 46 of file CachedESTInfo.h.
| CachedESTInfo::CachedESTInfo | ( | ) | [inline] |
The default constructor.
This class is heavily used in conjunction with STL containers (such as std::vector). Consequently, the default constructor is called very frequently when entries are added to the MSTCache. Therefore the constructor is very straightfoward to the point that it does absolutely nothing and is merely present to adhere to coding conventions.
Definition at line 57 of file CachedESTInfo.h.
| CachedESTInfo::CachedESTInfo | ( | const int | refESTidxValue, | |
| const int | estIdxValue, | |||
| const float | metricValue, | |||
| const int | alignmentDataValue, | |||
| const int | directionDataValue | |||
| ) | [inline] |
A convenience all parameter constructor.
This is a convenience constructor that is used to set up all the instance variables to corresponding values specified by the parameters.
| [in] | refESTidxValue | The zero-based index of the EST that was used as the reference EST which which EST at index estIdxValue was compared/analyzed to generate the metricValue. |
| [in] | estIdxValue | The zero-based index of the EST that was compared against the EST at index refESTidx to generate metricValue. |
| [in] | metricValue | The similarity/distance metric value to be stored in this object. |
| [in] | alignmentDataValue | Additional alignment information to be stored in this class. |
| [in] | directionDataValue | A integer value indicating the direction in which the information is to be considered. Positive values indicate normal comparison while negative values indicate reverse compliment comparison. |
Definition at line 85 of file CachedESTInfo.h.
| CachedESTInfo::~CachedESTInfo | ( | ) | [inline] |
The destructor.
This class does not contain any members that utilize dynamic memory to hold data. Consequently, the destructor has no special tasks to perform and is merely present to adhere to coding conventions.
Definition at line 98 of file CachedESTInfo.h.
The alignment information for this EST.
This instance variable is used to maintain the alignment data (if any) associated with the EST indicated by estIdx.
Definition at line 131 of file CachedESTInfo.h.
Referenced by TransCacheEntry::addEntries(), MSTMultiListCache::getBestEntry(), and MSTHeapCache::getBestEntry().
The direction information for this EST.
This instance variable is used to maintain the direction data (if any) associated with the EST indicated by estIdx.
Definition at line 138 of file CachedESTInfo.h.
Referenced by TransCacheEntry::addEntries(), MSTMultiListCache::getBestEntry(), and MSTHeapCache::getBestEntry().
The index of the EST for which this data is relevant.
This instance variable is used to store the index of one of the ESTs for which the remainder of the information has been stored.
Definition at line 114 of file CachedESTInfo.h.
Referenced by TransCacheEntry::addEntries(), MSTMultiListCache::getBestEntry(), and MSTHeapCache::getBestEntry().
| float CachedESTInfo::metric |
The distance/similarity metric value.
This instance variable is used to maintain the similarity/distance metric corresponding to the EST referred by estIdx. Note that this class does not contain the index of the reference EST as this information is maintained in the MSTCache directly.
Definition at line 124 of file CachedESTInfo.h.
Referenced by TransCacheEntry::addEntries(), MSTMultiListCache::getBestEntry(), MSTHeapCache::getBestEntry(), GreaterCachedESTInfo::operator()(), and LessCachedESTInfo::operator()().
The zero-based index of the reference EST.
This instance variable is used to store the zero-based index of the reference EST against which the EST at estIdx was analyzed to generate the metric and alginmentData.
Definition at line 106 of file CachedESTInfo.h.
Referenced by MSTHeapCache::getBestEntry().
1.6.1