NES::Integer Class Reference

The Integer type represents whole numbers, that is, numbers without fractional components, of various ranges. The internal Integer type is parameterised by its bit size, and its lower and upper bound Integer(bitSize, lowerBound, upperBound) More...

#include <Integer.hpp>

Collaboration diagram for NES::Integer:

Public Member Functions
	Integer (int8_t bits, int64_t lowerBound, int64_t upperBound) noexcept
	Constructs a new Integer type. More...
	~Integer () override=default
bool	isInteger () const override
	Checks if this data type is Integer. More...
bool	equals (DataTypePtr otherDataType) override
	Checks if two data types are equal. More...
DataTypePtr	join (DataTypePtr otherDataType) override
	Calculates the joined data type between this data type and the other. If they have no possible joined data type, the coined type is Undefined. For integers, we can join with all numeric data types. More...
std::string	toString () override
	Returns a string representation of the data type. More...
Public Member Functions inherited from NES::Numeric
	Numeric (int8_t bits)
	~Numeric () override=default
bool	isNumeric () const final
	Checks if this data type is Numeric. More...
int8_t	getBits () const
	Gets the bit size of this type. More...
Public Member Functions inherited from NES::DataType
virtual	~DataType ()=default
virtual bool	isUndefined () const
	Checks if this data type is Undefined. More...
virtual bool	isBoolean () const
	Checks if this data type is Boolean. More...
virtual bool	isFloat () const
	Checks if this data type is Float. More...
virtual bool	isArray () const
	Checks if this data type is ArrayType. More...
virtual bool	isCharArray () const
	Checks if this data type is ArrayType. More...
virtual bool	isChar () const
	Checks if this data type is Char. More...
virtual bool	isText () const
	Checks if this data type is Char. More...

Public Attributes
int64_t const	lowerBound
int64_t const	upperBound

Additional Inherited Members
Static Public Member Functions inherited from NES::DataType
template<class DataType >
static std::shared_ptr< DataType >	as (DataTypePtr ptr)
Protected Attributes inherited from NES::Numeric
const int8_t	bits

Detailed Description

The Integer type represents whole numbers, that is, numbers without fractional components, of various ranges. The internal Integer type is parameterised by its bit size, and its lower and upper bound Integer(bitSize, lowerBound, upperBound)

Constructor & Destructor Documentation

Integer()

NES::Integer::Integer ( int8_t  bits, int64_t  lowerBound, int64_t  upperBound  )

inlinenoexcept

Constructs a new Integer type.

Parameters

bits	the number of bits in which this type is represented.
lowerBound	the lower bound, which is contained in that integer.
upperBound	the upper bound, which is contained in that integer.

~Integer()

NES::Integer::~Integer ( )

overridedefault

Member Function Documentation

equals()

bool NES::Integer::equals ( DataTypePtr  otherDataType )

overridevirtual

Checks if two data types are equal.

Parameters

otherDataType

Returns

Implements NES::DataType.

References NES::Numeric::bits, lowerBound, and upperBound.

isInteger()

bool NES::Integer::isInteger ( ) const

inlineoverridevirtual

Checks if this data type is Integer.

Reimplemented from NES::DataType.

join()

DataTypePtr NES::Integer::join ( DataTypePtr  otherDataType )

overridevirtual

Calculates the joined data type between this data type and the other. If they have no possible joined data type, the coined type is Undefined. For integers, we can join with all numeric data types.

Parameters

other

data type

Returns

DataTypePtr joined data type

Implements NES::DataType.

References NES::Numeric::bits, NES::DataTypeFactory::createFloat(), NES::DataTypeFactory::createInteger(), NES::DataTypeFactory::createUndefined(), lowerBound, and upperBound.

Here is the call graph for this function:

toString()

std::string NES::Integer::toString ( )

overridevirtual

Returns a string representation of the data type.

Returns

string

Implements NES::DataType.

References NES::Numeric::bits.

Member Data Documentation

lowerBound

int64_t const NES::Integer::lowerBound

Referenced by equals(), and join().

upperBound

int64_t const NES::Integer::upperBound

Referenced by equals(), and join().

---

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

• /nebulastream/nes-data-types/include/Common/DataTypes/Integer.hpp
• /nebulastream/nes-data-types/src/Common/DataTypes/Integer.cpp