MeshLib C Docs
Loading...
Searching...
No Matches
std_vector_int.h File Reference
#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
#include <stdbool.h>
#include <stddef.h>

Go to the source code of this file.

Functions

MRC_API MR_std_vector_int * MR_std_vector_int_DefaultConstruct (void)
MRC_API MR_std_vector_int * MR_std_vector_int_DefaultConstructArray (size_t num_elems)
MRC_API MR_std_vector_int * MR_std_vector_int_ConstructFromAnother (MR_PassBy other_pass_by, MR_std_vector_int *other)
MRC_API void MR_std_vector_int_AssignFromAnother (MR_std_vector_int *_this, MR_PassBy other_pass_by, MR_std_vector_int *other)
MRC_API void MR_std_vector_int_Destroy (const MR_std_vector_int *_this)
 Destroys a heap-allocated instance of MR_std_vector_int. Does nothing if the pointer is null.
MRC_API void MR_std_vector_int_DestroyArray (const MR_std_vector_int *_this)
 Destroys a heap-allocated array of MR_std_vector_int. Does nothing if the pointer is null.
MRC_API const MR_std_vector_int * MR_std_vector_int_OffsetPtr (const MR_std_vector_int *ptr, ptrdiff_t i)
MRC_API MR_std_vector_int * MR_std_vector_int_OffsetMutablePtr (MR_std_vector_int *ptr, ptrdiff_t i)
MRC_API size_t MR_std_vector_int_size (const MR_std_vector_int *_this)
MRC_API bool MR_std_vector_int_empty (const MR_std_vector_int *_this)
MRC_API void MR_std_vector_int_resize (MR_std_vector_int *_this, size_t new_size)
MRC_API void MR_std_vector_int_clear (MR_std_vector_int *_this)
MRC_API void MR_std_vector_int_reserve (MR_std_vector_int *_this, size_t new_capacity)
MRC_API const int * MR_std_vector_int_at (const MR_std_vector_int *_this, size_t i)
MRC_API int * MR_std_vector_int_at_mut (MR_std_vector_int *_this, size_t i)
MRC_API const int * MR_std_vector_int_front (const MR_std_vector_int *_this)
MRC_API int * MR_std_vector_int_front_mut (MR_std_vector_int *_this)
MRC_API const int * MR_std_vector_int_back (const MR_std_vector_int *_this)
MRC_API int * MR_std_vector_int_back_mut (MR_std_vector_int *_this)
MRC_API const int * MR_std_vector_int_data (const MR_std_vector_int *_this)
MRC_API int * MR_std_vector_int_data_mut (MR_std_vector_int *_this)
MRC_API void MR_std_vector_int_push_back (MR_std_vector_int *_this, int new_elem)
MRC_API void MR_std_vector_int_pop_back (MR_std_vector_int *_this)
MRC_API void MR_std_vector_int_insert (MR_std_vector_int *_this, size_t position, int new_elem)
MRC_API void MR_std_vector_int_erase (MR_std_vector_int *_this, size_t position)

Function Documentation

◆ MR_std_vector_int_AssignFromAnother()

MRC_API void MR_std_vector_int_AssignFromAnother ( MR_std_vector_int * _this,
MR_PassBy other_pass_by,
MR_std_vector_int * other )

Assigns the contents from another instance. Both objects remain alive after the call. Parameter _this can not be null. It is a single object. The reference to the parameter other might be preserved in this object. When this function is called, this object will drop any object references it held previously.

◆ MR_std_vector_int_at()

MRC_API const int * MR_std_vector_int_at ( const MR_std_vector_int * _this,
size_t i )

The element at a specific index, read-only. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.

◆ MR_std_vector_int_at_mut()

MRC_API int * MR_std_vector_int_at_mut ( MR_std_vector_int * _this,
size_t i )

The element at a specific index, mutable. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.

◆ MR_std_vector_int_back()

MRC_API const int * MR_std_vector_int_back ( const MR_std_vector_int * _this)

The last element or null if empty, read-only. Parameter _this can not be null. It is a single object. The reference to this object might be preserved as the return value.

◆ MR_std_vector_int_back_mut()

MRC_API int * MR_std_vector_int_back_mut ( MR_std_vector_int * _this)

The last element or null if empty, mutable. Parameter _this can not be null. It is a single object. The reference to this object might be preserved as the return value.

◆ MR_std_vector_int_clear()

MRC_API void MR_std_vector_int_clear ( MR_std_vector_int * _this)

Removes all elements from the container. Parameter _this can not be null. It is a single object. When this function is called, this object will drop any object references it held previously.

◆ MR_std_vector_int_ConstructFromAnother()

MRC_API MR_std_vector_int * MR_std_vector_int_ConstructFromAnother ( MR_PassBy other_pass_by,
MR_std_vector_int * other )

Constructs a copy of another instance. The source remains alive. The reference to the parameter other might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_vector_int_Destroy() to free it when you're done using it. When this function is called, this object will drop any object references it held previously.

◆ MR_std_vector_int_data()

MRC_API const int * MR_std_vector_int_data ( const MR_std_vector_int * _this)

Returns a pointer to the continuous storage that holds all elements, read-only. Parameter _this can not be null. It is a single object. The reference to this object might be preserved as the return value.

◆ MR_std_vector_int_data_mut()

MRC_API int * MR_std_vector_int_data_mut ( MR_std_vector_int * _this)

Returns a pointer to the continuous storage that holds all elements, mutable. Parameter _this can not be null. It is a single object. The reference to this object might be preserved as the return value.

◆ MR_std_vector_int_DefaultConstruct()

MRC_API MR_std_vector_int * MR_std_vector_int_DefaultConstruct ( void )

Constructs an empty (default-constructed) instance. Never returns null. Returns an instance allocated on the heap! Must call MR_std_vector_int_Destroy() to free it when you're done using it.

◆ MR_std_vector_int_DefaultConstructArray()

MRC_API MR_std_vector_int * MR_std_vector_int_DefaultConstructArray ( size_t num_elems)

Constructs an array of empty (default-constructed) instances, of the specified size. Will never return null. The array must be destroyed using MR_std_vector_int_DestroyArray(). Use MR_std_vector_int_OffsetMutablePtr() and MR_std_vector_int_OffsetPtr() to access the array elements.

◆ MR_std_vector_int_Destroy()

MRC_API void MR_std_vector_int_Destroy ( const MR_std_vector_int * _this)

Destroys a heap-allocated instance of MR_std_vector_int. Does nothing if the pointer is null.

◆ MR_std_vector_int_DestroyArray()

MRC_API void MR_std_vector_int_DestroyArray ( const MR_std_vector_int * _this)

Destroys a heap-allocated array of MR_std_vector_int. Does nothing if the pointer is null.

◆ MR_std_vector_int_empty()

MRC_API bool MR_std_vector_int_empty ( const MR_std_vector_int * _this)

Returns true if the size is zero. Parameter _this can not be null. It is a single object.

◆ MR_std_vector_int_erase()

MRC_API void MR_std_vector_int_erase ( MR_std_vector_int * _this,
size_t position )

Erases the element at the specified position. Parameter _this can not be null. It is a single object.

◆ MR_std_vector_int_front()

MRC_API const int * MR_std_vector_int_front ( const MR_std_vector_int * _this)

The first element or null if empty, read-only. Parameter _this can not be null. It is a single object. The reference to this object might be preserved as the return value.

◆ MR_std_vector_int_front_mut()

MRC_API int * MR_std_vector_int_front_mut ( MR_std_vector_int * _this)

The first element or null if empty, mutable. Parameter _this can not be null. It is a single object. The reference to this object might be preserved as the return value.

◆ MR_std_vector_int_insert()

MRC_API void MR_std_vector_int_insert ( MR_std_vector_int * _this,
size_t position,
int new_elem )

Inserts a new element right before the specified position. Parameter _this can not be null. It is a single object.

◆ MR_std_vector_int_OffsetMutablePtr()

MRC_API MR_std_vector_int * MR_std_vector_int_OffsetMutablePtr ( MR_std_vector_int * ptr,
ptrdiff_t i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

◆ MR_std_vector_int_OffsetPtr()

MRC_API const MR_std_vector_int * MR_std_vector_int_OffsetPtr ( const MR_std_vector_int * ptr,
ptrdiff_t i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

◆ MR_std_vector_int_pop_back()

MRC_API void MR_std_vector_int_pop_back ( MR_std_vector_int * _this)

Removes one element from the end. Parameter _this can not be null. It is a single object.

◆ MR_std_vector_int_push_back()

MRC_API void MR_std_vector_int_push_back ( MR_std_vector_int * _this,
int new_elem )

Inserts a new element at the end. Parameter _this can not be null. It is a single object.

◆ MR_std_vector_int_reserve()

MRC_API void MR_std_vector_int_reserve ( MR_std_vector_int * _this,
size_t new_capacity )

Reserves memory for a certain number of elements. Never shrinks the memory. Parameter _this can not be null. It is a single object.

◆ MR_std_vector_int_resize()

MRC_API void MR_std_vector_int_resize ( MR_std_vector_int * _this,
size_t new_size )

Resizes the container. The new elements if any are zeroed. Parameter _this can not be null. It is a single object.

◆ MR_std_vector_int_size()

MRC_API size_t MR_std_vector_int_size ( const MR_std_vector_int * _this)

The number of elements. Parameter _this can not be null. It is a single object.