OnixS C++ CBOE CFE Binary Order Entry (BOE) Handler  1.11.0
API documentation
Public Types | Public Member Functions | List of all members
FixedPointDecimal< MantissaType, ExponentType > Class Template Reference

#include <OnixS/CboeCFE/Trading/BOE/Decimal.h>

Public Types

enum  { Size = sizeof(Mantissa) }
 
typedef MantissaType Mantissa
 
typedef ExponentType Exponent
 

Public Member Functions

 FixedPointDecimal ()
 
 FixedPointDecimal (Mantissa mantissa)
 
 FixedPointDecimal (const FixedPointDecimal &other)
 
Mantissa mantissa () const
 
ONIXS_BATS_BOE_CONSTEXPR Exponent exponent () const
 
FixedPointDecimal & operator= (const FixedPointDecimal &other)
 

Detailed Description

template<class MantissaType, class ExponentType>
class OnixS::CboeCFE::Trading::BOE::FixedPointDecimal< MantissaType, ExponentType >

Represents real number with constant exponent.

BOE Platform currently operates prices and scaling factors as real numbers with constant exponent. This class implements concept of fixed point decimal and lets to dramatically improve performance of book-related operations.

Definition at line 44 of file Decimal.h.

Member Typedef Documentation

typedef ExponentType Exponent

Aliases exponent component type.

Definition at line 54 of file Decimal.h.

typedef MantissaType Mantissa

Aliases mantissa component type.

Definition at line 51 of file Decimal.h.

Member Enumeration Documentation

anonymous enum

A few traits.

Enumerator
Size 

Size of class in bytes. 

                    Instantiations of given class are used 
                    while manipulating binary messages. Regular 
                    composites expose given characteristics so 
                    as this template class does.

Definition at line 57 of file Decimal.h.

Constructor & Destructor Documentation

FixedPointDecimal ( )
inline

Default (zero) initialization.

Definition at line 69 of file Decimal.h.

FixedPointDecimal ( Mantissa  mantissa)
inlineexplicit

Explicitly initializes instance from its mantissa value.

Definition at line 75 of file Decimal.h.

FixedPointDecimal ( const FixedPointDecimal< MantissaType, ExponentType > &  other)
inline

Initializes instance as copy of the other one.

Definition at line 81 of file Decimal.h.

Member Function Documentation

ONIXS_BATS_BOE_CONSTEXPR Exponent exponent ( ) const
inline

Returns exponent of given decimal.

Definition at line 94 of file Decimal.h.

Mantissa mantissa ( ) const
inline

Returns mantissa of given decimal.

Definition at line 87 of file Decimal.h.

FixedPointDecimal& operator= ( const FixedPointDecimal< MantissaType, ExponentType > &  other)
inline

Re-initializes instance as copy of the other one.

Definition at line 100 of file Decimal.h.

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