NCBI C++ ToolKit
Public Types | Public Member Functions | List of all members
CScoreLookup::IScore Class Referenceabstract

Search Toolkit Book for CScoreLookup::IScore

#include <algo/align/util/score_lookup.hpp>

+ Inheritance diagram for CScoreLookup::IScore:
+ Collaboration diagram for CScoreLookup::IScore:

Public Types

enum  EComplexity { eEasy, eHard }
 
- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1, eAllocFillZero, eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue TCount
 Alias for value type of counter. More...
 

Public Member Functions

virtual ~IScore ()
 
virtual double Get (const objects::CSeq_align &align, objects::CScope *scope) const =0
 
virtual void PrintHelp (CNcbiOstream &ostr) const =0
 
virtual EComplexity GetComplexity () const
 
virtual bool IsInteger () const
 
virtual void UpdateState (const objects::CSeq_align &align)
 For any IScore subclasses that have an internal state, this function will be called to update it for any alignment that matches the filter. More...
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 

Additional Inherited Members

- Static Public Member Functions inherited from CObject
static NCBI_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 50 of file score_lookup.hpp.

Member Enumeration Documentation

Enumerator
eEasy 
eHard 

Definition at line 53 of file score_lookup.hpp.

Constructor & Destructor Documentation

virtual CScoreLookup::IScore::~IScore ( )
inlinevirtual

Definition at line 58 of file score_lookup.hpp.

Member Function Documentation

virtual double CScoreLookup::IScore::Get ( const objects::CSeq_align &  align,
objects::CScope *  scope 
) const
pure virtual
virtual EComplexity CScoreLookup::IScore::GetComplexity ( ) const
inlinevirtual
virtual bool CScoreLookup::IScore::IsInteger ( ) const
inlinevirtual
virtual void CScoreLookup::IScore::PrintHelp ( CNcbiOstream ostr) const
pure virtual
virtual void CScoreLookup::IScore::UpdateState ( const objects::CSeq_align &  align)
inlinevirtual

For any IScore subclasses that have an internal state, this function will be called to update it for any alignment that matches the filter.

Reimplemented in CScore_Overlap.

Definition at line 68 of file score_lookup.hpp.


The documentation for this class was generated from the following file:
Modified on Wed Feb 10 16:11:05 2016 by modify_doxy.py rev. 426318