Quantum.Allocator.Heap.Config Struct Reference

The configuration of the frame heap. More...

Public Member Functions
	Config (int pageShift, int pageCount, int heapCount)
	Initializes a new instance of the Config struct. More...
readonly bool	Equals (Config other)
	Determines whether the specified object is equal to the current object. More...
readonly override bool	Equals (object obj)
	Determines whether the specified object is equal to the current object. More...
readonly override int	GetHashCode ()
	Serves as the default hash function. More...
readonly override string	ToString ()
	Returns a string that represents the current object. More...

Static Public Member Functions
static Config	Default (int heapCount)
	Gets the default configuration. More...
static bool	operator!= (Config a, Config b)
	Determines whether two instances of Config are not equal. More...
static bool	operator== (Config a, Config b)
	Determines whether two instances of Config are equal. More...

Public Attributes
readonly int	HEAP_COUNT
	Sets extra heaps to allocate for a session in case you need to create 'auxiliary' frames than actually required for the simulation itself. More...
readonly int	HEAP_SIZE
	Heap size defined by PAGE_SIZE times PAGE_COUNT. More...
readonly int	PAGE_COUNT
	Define the max heap page count for memory the frame class uses for custom allocations like QList for example. More...
readonly int	PAGE_SHIFT
	Define the max heap size for one page of memory the frame class uses for custom allocations like QList for example. More...
readonly int	PAGE_SIZE
	Using the PAGE_SHIFT resulting size. More...
readonly int	SMALL_BIN_ARRAY_SIZE
	Small bin array size. More...
readonly int	SMALL_BIN_COUNT
	The number of small bins. More...
readonly int	SMALL_BIN_SIZE
	The threshold for small objects. More...

Detailed Description

The configuration of the frame heap.

Constructor & Destructor Documentation

Config()

Quantum.Allocator.Heap.Config.Config ( int  pageShift, int  pageCount, int  heapCount  )

inline

Initializes a new instance of the Config struct.

Parameters

pageShift	The page shift value.
pageCount	The page count value.
heapCount	The heap count value.

Member Function Documentation

Default()

static Config Quantum.Allocator.Heap.Config.Default ( int  heapCount )

inlinestatic

Gets the default configuration.

Parameters

heapCount

The heap count value.

Returns

The default configuration.

Equals() [1/2]

readonly bool Quantum.Allocator.Heap.Config.Equals ( Config  other )

inline

Determines whether the specified object is equal to the current object.

Parameters

other

The object to compare with the current object.

Returns

true if the specified object is equal to the current object; otherwise, false.

Equals() [2/2]

readonly override bool Quantum.Allocator.Heap.Config.Equals ( object  obj )

inline

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

readonly override int Quantum.Allocator.Heap.Config.GetHashCode ( )

inline

Serves as the default hash function.

Returns

A hash code for the current object.

operator==()

static bool Quantum.Allocator.Heap.Config.operator== ( Config  a, Config  b  )

inlinestatic

Determines whether two instances of Config are equal.

Parameters

a	The first instance to compare.
b	The second instance to compare.

Returns

true if the instances are equal; otherwise, false.

operator!=()

static bool Quantum.Allocator.Heap.Config.operator!= ( Config  a, Config  b  )

inlinestatic

Determines whether two instances of Config are not equal.

Parameters

a	The first instance to compare.
b	The second instance to compare.

Returns

true if the instances are not equal; otherwise, false.

ToString()

readonly override string Quantum.Allocator.Heap.Config.ToString ( )

inline

Returns a string that represents the current object.

Returns

A string that represents the current object.

Member Data Documentation

PAGE_SHIFT

readonly int Quantum.Allocator.Heap.Config.PAGE_SHIFT

Define the max heap size for one page of memory the frame class uses for custom allocations like QList for example.

PAGE_COUNT

readonly int Quantum.Allocator.Heap.Config.PAGE_COUNT

Define the max heap page count for memory the frame class uses for custom allocations like QList for example.

PAGE_SIZE

readonly int Quantum.Allocator.Heap.Config.PAGE_SIZE

Using the PAGE_SHIFT resulting size.

HEAP_SIZE

readonly int Quantum.Allocator.Heap.Config.HEAP_SIZE

Heap size defined by PAGE_SIZE times PAGE_COUNT.

HEAP_COUNT

readonly int Quantum.Allocator.Heap.Config.HEAP_COUNT

Sets extra heaps to allocate for a session in case you need to create 'auxiliary' frames than actually required for the simulation itself.

SMALL_BIN_SIZE

readonly int Quantum.Allocator.Heap.Config.SMALL_BIN_SIZE

The threshold for small objects.

SMALL_BIN_COUNT

readonly int Quantum.Allocator.Heap.Config.SMALL_BIN_COUNT

The number of small bins.

SMALL_BIN_ARRAY_SIZE

readonly int Quantum.Allocator.Heap.Config.SMALL_BIN_ARRAY_SIZE

Small bin array size.