NCBI C++ ToolKit
Public Types | Public Member Functions | Private Types | Private Member Functions | List of all members
CInt_fuzz Class Reference

Search Toolkit Book for CInt_fuzz

#include <objects/general/Int_fuzz.hpp>

+ Inheritance diagram for CInt_fuzz:
+ Collaboration diagram for CInt_fuzz:

Public Types

enum  ECombine { eAmplify , eReduce }
 
- Public Types inherited from CInt_fuzz_Base
enum  ELim {
  eLim_unk = 0 , eLim_gt = 1 , eLim_lt = 2 , eLim_tr = 3 ,
  eLim_tl = 4 , eLim_circle = 5 , eLim_other = 255
}
 some limit value More...
 
enum  E_Choice {
  e_not_set = 0 , e_P_m , e_Range , e_Pct ,
  e_Lim , e_Alt
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 6 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef TSeqPos TP_m
 
typedef C_Range TRange
 
typedef int TPct
 
typedef ELim TLim
 
typedef list< TSeqPosTAlt
 
- 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 atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CInt_fuzz (void)
 
 ~CInt_fuzz (void)
 
void GetLabel (string *label, TSeqPos pos, bool right=true) const
 
void AssignTranslated (const CInt_fuzz &f2, TSeqPos n1, TSeqPos n2)
 n1 and n2 are the targets of the fuzz More...
 
void Add (const CInt_fuzz &f2, TSeqPos &n1, TSeqPos n2, ECombine mode=eAmplify)
 
void Subtract (const CInt_fuzz &f2, TSeqPos &n1, TSeqPos n2, ECombine mode=eReduce)
 
void Negate (TSeqPos n)
 
CRef< CInt_fuzzNegative (TSeqPos n) const
 
- Public Member Functions inherited from CInt_fuzz_Base
 CInt_fuzz_Base (void)
 
virtual ~CInt_fuzz_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
virtual void Reset (void)
 Reset the whole object. More...
 
virtual void ResetSelection (void)
 Reset the selection (set it to e_not_set). More...
 
E_Choice Which (void) const
 Which variant is currently selected. More...
 
void CheckSelected (E_Choice index) const
 Verify selection, throw exception if it differs from the expected. More...
 
void ThrowInvalidSelection (E_Choice index) const
 Throw 'InvalidSelection' exception. More...
 
void Select (E_Choice index, EResetVariant reset=eDoResetVariant)
 Select the requested variant if needed. More...
 
void Select (E_Choice index, EResetVariant reset, CObjectMemoryPool *pool)
 Select the requested variant if needed, allocating CObject variants from memory pool. More...
 
bool IsP_m (void) const
 Check if variant P_m is selected. More...
 
TP_m GetP_m (void) const
 Get the variant data. More...
 
TP_mSetP_m (void)
 Select the variant. More...
 
void SetP_m (TP_m value)
 Select the variant and set its data. More...
 
bool IsRange (void) const
 Check if variant Range is selected. More...
 
const TRangeGetRange (void) const
 Get the variant data. More...
 
TRangeSetRange (void)
 Select the variant. More...
 
void SetRange (TRange &value)
 Select the variant and set its data. More...
 
bool IsPct (void) const
 Check if variant Pct is selected. More...
 
TPct GetPct (void) const
 Get the variant data. More...
 
TPctSetPct (void)
 Select the variant. More...
 
void SetPct (TPct value)
 Select the variant and set its data. More...
 
bool IsLim (void) const
 Check if variant Lim is selected. More...
 
TLim GetLim (void) const
 Get the variant data. More...
 
TLimSetLim (void)
 Select the variant. More...
 
void SetLim (TLim value)
 Select the variant and set its data. More...
 
bool IsAlt (void) const
 Check if variant Alt is selected. More...
 
const TAltGetAlt (void) const
 Get the variant data. More...
 
TAltSetAlt (void)
 Select the variant. More...
 
- Public Member Functions inherited from CSerialObject
 CSerialObject (void)
 
virtual ~CSerialObject (void)
 
virtual const CTypeInfoGetThisTypeInfo (void) const =0
 
virtual void Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive)
 Set object to copy of another one. More...
 
virtual bool Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const
 Check if both objects contain the same values. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
void ThrowUnassigned (TMemberIndex index) const
 
void ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const
 
bool HasNamespaceName (void) const
 Check if object data type has namespace name. More...
 
const stringGetNamespaceName (void) const
 Get namespace name. More...
 
bool HasNamespacePrefix (void) const
 Check if data type has namespace prefix. More...
 
const stringGetNamespacePrefix (void) const
 Get namespace prefix. 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...
 
- 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
 
void DumpToConsole (void) const
 

Private Types

typedef CInt_fuzz_Base Tparent
 

Private Member Functions

 CInt_fuzz (const CInt_fuzz &value)
 
CInt_fuzzoperator= (const CInt_fuzz &value)
 

Additional Inherited Members

- Static Public Member Functions inherited from CInt_fuzz_Base
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() ELim (void)
 Access to ELim's attributes (values, names) as defined in spec. More...
 
static string SelectionName (E_Choice index)
 Retrieve selection name (for diagnostic purposes). More...
 
- Static Public Member Functions inherited from CSerialObject
static void SetVerifyDataThread (ESerialVerifyData verify)
 
static void SetVerifyDataGlobal (ESerialVerifyData verify)
 
static string UnassignedString (void)
 
static CStringUTF8 UnassignedStringUTF8 (void)
 
static char UnassignedByte (void)
 
- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT 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 CSerialObject
static const char * ms_UnassignedStr = "<*unassigned*>"
 
static const char ms_UnassignedByte = char(0xcd)
 
- 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 53 of file Int_fuzz.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 55 of file Int_fuzz.hpp.

Member Enumeration Documentation

◆ ECombine

Enumerator
eAmplify 

go for the largest possible range

eReduce 

go for the smallest range that allows each value individually to vary freely as long as the other balances it out to the extent possible

Definition at line 67 of file Int_fuzz.hpp.

Constructor & Destructor Documentation

◆ CInt_fuzz() [1/2]

CInt_fuzz::CInt_fuzz ( void  )
inline

Definition at line 100 of file Int_fuzz.hpp.

◆ ~CInt_fuzz()

CInt_fuzz::~CInt_fuzz ( void  )

Definition at line 56 of file Int_fuzz.cpp.

◆ CInt_fuzz() [2/2]

CInt_fuzz::CInt_fuzz ( const CInt_fuzz value)
private

Member Function Documentation

◆ Add()

void CInt_fuzz::Add ( const CInt_fuzz f2,
TSeqPos n1,
TSeqPos  n2,
ECombine  mode = eAmplify 
)

◆ AssignTranslated()

void CInt_fuzz::AssignTranslated ( const CInt_fuzz f2,
TSeqPos  n1,
TSeqPos  n2 
)

◆ GetLabel()

void CInt_fuzz::GetLabel ( string label,
TSeqPos  pos,
bool  right = true 
) const

◆ Negate()

void CInt_fuzz::Negate ( TSeqPos  n)

◆ Negative()

CRef< CInt_fuzz > CInt_fuzz::Negative ( TSeqPos  n) const
inline

Definition at line 106 of file Int_fuzz.hpp.

References n, and result.

Referenced by SRelLoc::SRelLoc(), Subtract(), and CAlignmentAssistant::TranslateLocations().

◆ operator=()

CInt_fuzz& CInt_fuzz::operator= ( const CInt_fuzz value)
private

◆ Subtract()

void CInt_fuzz::Subtract ( const CInt_fuzz f2,
TSeqPos n1,
TSeqPos  n2,
ECombine  mode = eReduce 
)
inline

Definition at line 116 of file Int_fuzz.hpp.

References Add(), and Negative().


The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:57:56 2024 by modify_doxy.py rev. 669887