Ring 1 Libraries
Introduction
Concepts
Byte Buffer Library
Introduction
Ring1_ByteBuffer
Ring1_ByteBuffer_Capacity_Default
Ring1_ByteBuffer_Capacity_Greatest
Ring1_ByteBuffer_Capacity_Least
Ring1_ByteBuffer_appendByte
Ring1_ByteBuffer_appendBytes
Ring1_ByteBuffer_prependByte
Ring1_ByteBuffer_prependBytes
Ring1_ByteBuffer_insertByteAt
Ring1_ByteBuffer_insertBytesAt
Ring1_ByteBuffer_clear
Ring1_ByteBuffer_initialize
Ring1_ByteBuffer_uninitialize
Ring1_ByteBuffer_getBytes
Ring1_ByteBuffer_getNumberOfBytes
Collections Library
Ring1_Collection_AddedCallback
Ring1_Collection_RemovedCallback
File System Library
Introduction
Ring1_FileSystem_getFileContents
Ring1_FileSystem_setFileContents
Ring1_FileSystem_AllocateCallback
Ring1_FileSystem_DeallocateCallback
Ring1_FileSystem_ExistingFilePolicy
Ring1_FileSystem_FileAccessMode
Ring1_FileSystem_NonExistingFilePolicy
Hash Library
Introduction
Ring1_Hash_toI64
Ring1_Hash_toSz
Intrinsic Library
Introduction
Ring1_Intrinsic_add
Ring1_Intrinsic_atomicDecrement_s32
Ring1_Intrinsic_atomicGet_s32
Ring1_Intrinsic_atomicIncrement_s32
Ring1_Intrinsic_CheckReturn
Ring1_Intrinsic_countLeadingZeroes
Ring1_Intrinsic_Deprecated
Ring1_Intrinsic_isPowerOfTwo
Ring1_Intrinsic_Inline
Ring1_Intrinsic_multiply
Ring1_Intrinsic_nextPowerOfTwo
Ring1_Intrinsic_NoReturn
Ring1_Intrinsic_subtract
Ring1_Intrinsic_ThreadLocal
Ring1_Intrinsic_maximum
Ring1_Intrinsic_minimum
Ring1_Intrinsic_clamp
Ring1_Intrinsic_Fp_ExponentBits
Ring1_Intrinsic_Fp_ExponentMask
Ring1_Intrinsic_Fp_SignificantBits
Ring1_Intrinsic_Fp_SignificantMask
Ring1_Intrinsic_Fp_SignBits
Ring1_Intrinsic_Fp_SignMask
Ring1_Intrinsic_Fp_PositiveZeroBits
Ring1_Intrinsic_Fp_NegativeZeroBits
Ring1_Intrinsic_Fp_NoNumber
Ring1_Intrinsic_Fp_Infinity
Ring1_Intrinsic_Fp_getBits
Ring1_Intrinsic_Fp_getRawBits
Ring1_Intrinsic_ByteOrder
Memory Library
Ring1_Memory_recomputeSize
Ring1_Memory_allocate
Ring1_Memory_allocateArray
Ring1_Memory_deallocate
Ring1_Memory_reallocate
Ring1_Memory_reallocateArray
Ring1_Memory_zeroFill
Ring1_Memory_zeroFillArray
Ring1_Memory_getPageSize
Ring1_Memory_copyArrayFast
Ring1_Memory_copyArraySlow
Ring1_Memory_copyFast
Ring1_Memory_copySlow
Pointer List Library
Ring1_PointerList
Ring1_PointerList_initialize
Ring1_PointerList_uninitialize
Ring1_PointerList_Capacity_Least
Ring1_PointerList_Capacity_Greatest
Ring1_PointerList_Capacity_Default
Ring1_PointerList_clear
Result Library
Introduction
Result Codes
Ring1_Result
Status Library
Introduction
Status Codes
Ring1_Status
Ring1_Status_get
Ring1_Status_set
Time Library
Ring1_Time_getNowMilliseconds
Ring1_Time_getNowSeconds
Ring1_Time_getNowMinutes
Design Rational
\( % Arcus cosine. \def\acos{\cos^{-1}} % Vector projection. \def\projection#1#2{{proj_{#1}\left(#2\right)}} % Vector rejection. \def\rejection#1#2{{rej_{#1}\left(#2\right)}} % Norm. \def\norm#1{{\left\|#1\right\|}} % Cross product. \def\cross#1#2{\mathit{cross}\left(#1,#2\right)} % Dot product. \def\dot#1#2{{#1 \cdot #2}} % Magnitude. \def\mag#1{{\left|#1\right}} \def\group#1{\left(#1\right)}} \def\sbgrp#1{\left\{#1\right\}} \)

Ring1_PointerList_initialize

Initialize a pointer list.

Ring1_Result
Ring1_PointerList_initialize
  (
    Ring1_PointerList *self,
    Ring1_Collection_AddedCallback *added,
    Ring1_Collection_RemovedCallback *removed
  )

This function initializes an uninitialized pointer list with a pointer list's default capacity and the specified added and removed callbacks. This pointer list must not be initialized, otherwise the behavior of this function is undefined.

Parameter variables

self
A pointer to the pointer list.
added
A pointer to an Ring1_Collection_AddedCallback function or a null pointer. This function is invoked on an element if it is added to the pointer list.
removed
A pointer to an Ring1_Collection_RemovedCallback function or a null pointer. This function is invoked on an element if it is removed from the pointer list.

Return Values

Ring1_Result_Success on success, Ring1_Result_Failure on failure.