std_pair_uint64_t_uint64_t.h File Reference

#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
#include <stddef.h>

Go to the source code of this file.

Typedefs
typedef struct MR_std_pair_uint64_t_uint64_t	MR_std_pair_uint64_t_uint64_t

Functions
MRC_API MR_std_pair_uint64_t_uint64_t *	MR_std_pair_uint64_t_uint64_t_DefaultConstruct (void)
MRC_API MR_std_pair_uint64_t_uint64_t *	MR_std_pair_uint64_t_uint64_t_DefaultConstructArray (size_t num_elems)
MRC_API MR_std_pair_uint64_t_uint64_t *	MR_std_pair_uint64_t_uint64_t_ConstructFromAnother (const MR_std_pair_uint64_t_uint64_t *other)
MRC_API void	MR_std_pair_uint64_t_uint64_t_AssignFromAnother (MR_std_pair_uint64_t_uint64_t *_this, const MR_std_pair_uint64_t_uint64_t *other)
MRC_API void	MR_std_pair_uint64_t_uint64_t_Destroy (const MR_std_pair_uint64_t_uint64_t *_this)
	Destroys a heap-allocated instance of MR_std_pair_uint64_t_uint64_t. Does nothing if the pointer is null.
MRC_API void	MR_std_pair_uint64_t_uint64_t_DestroyArray (const MR_std_pair_uint64_t_uint64_t *_this)
	Destroys a heap-allocated array of MR_std_pair_uint64_t_uint64_t. Does nothing if the pointer is null.
MRC_API const MR_std_pair_uint64_t_uint64_t *	MR_std_pair_uint64_t_uint64_t_OffsetPtr (const MR_std_pair_uint64_t_uint64_t *ptr, ptrdiff_t i)
MRC_API MR_std_pair_uint64_t_uint64_t *	MR_std_pair_uint64_t_uint64_t_OffsetMutablePtr (MR_std_pair_uint64_t_uint64_t *ptr, ptrdiff_t i)
MRC_API MR_std_pair_uint64_t_uint64_t *	MR_std_pair_uint64_t_uint64_t_Construct (MR_uint64_t first, MR_uint64_t second)
MRC_API const MR_uint64_t *	MR_std_pair_uint64_t_uint64_t_First (const MR_std_pair_uint64_t_uint64_t *_this)
MRC_API MR_uint64_t *	MR_std_pair_uint64_t_uint64_t_MutableFirst (MR_std_pair_uint64_t_uint64_t *_this)
MRC_API const MR_uint64_t *	MR_std_pair_uint64_t_uint64_t_Second (const MR_std_pair_uint64_t_uint64_t *_this)
MRC_API MR_uint64_t *	MR_std_pair_uint64_t_uint64_t_MutableSecond (MR_std_pair_uint64_t_uint64_t *_this)

Typedef Documentation

MR_std_pair_uint64_t_uint64_t

typedef struct MR_std_pair_uint64_t_uint64_t MR_std_pair_uint64_t_uint64_t

Stores two objects: MR_uint64_t and MR_uint64_t. Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

Function Documentation

MR_std_pair_uint64_t_uint64_t_AssignFromAnother()

MRC_API void MR_std_pair_uint64_t_uint64_t_AssignFromAnother	(	MR_std_pair_uint64_t_uint64_t *	_this,
		const MR_std_pair_uint64_t_uint64_t *	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. Parameter other 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 had previously.

MR_std_pair_uint64_t_uint64_t_Construct()

MRC_API MR_std_pair_uint64_t_uint64_t * MR_std_pair_uint64_t_uint64_t_Construct	(	MR_uint64_t	first,
		MR_uint64_t	second )

Constructs the pair elementwise. The reference to the parameter first might be preserved in the constructed object. The reference to the parameter second might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_pair_uint64_t_uint64_t_Destroy() to free it when you're done using it. When this function is called, this object will drop any object references it had previously.

MR_std_pair_uint64_t_uint64_t_ConstructFromAnother()

MRC_API MR_std_pair_uint64_t_uint64_t * MR_std_pair_uint64_t_uint64_t_ConstructFromAnother

(

const MR_std_pair_uint64_t_uint64_t *

other

)

Constructs a copy of another instance. The source remains alive. Parameter other can not be null. It is a single object. 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_pair_uint64_t_uint64_t_Destroy() to free it when you're done using it. When this function is called, this object will drop any object references it had previously.

MR_std_pair_uint64_t_uint64_t_DefaultConstruct()

MRC_API MR_std_pair_uint64_t_uint64_t * MR_std_pair_uint64_t_uint64_t_DefaultConstruct

(

void

)

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

MR_std_pair_uint64_t_uint64_t_DefaultConstructArray()

MRC_API MR_std_pair_uint64_t_uint64_t * MR_std_pair_uint64_t_uint64_t_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_pair_uint64_t_uint64_t_DestroyArray(). Use MR_std_pair_uint64_t_uint64_t_OffsetMutablePtr() and MR_std_pair_uint64_t_uint64_t_OffsetPtr() to access the array elements.

MR_std_pair_uint64_t_uint64_t_Destroy()

MRC_API void MR_std_pair_uint64_t_uint64_t_Destroy

(

const MR_std_pair_uint64_t_uint64_t *

_this

)

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

MR_std_pair_uint64_t_uint64_t_DestroyArray()

MRC_API void MR_std_pair_uint64_t_uint64_t_DestroyArray

(

const MR_std_pair_uint64_t_uint64_t *

_this

)

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

MR_std_pair_uint64_t_uint64_t_First()

MRC_API const MR_uint64_t * MR_std_pair_uint64_t_uint64_t_First

(

const MR_std_pair_uint64_t_uint64_t *

_this

)

The first of the two elements, 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.

MR_std_pair_uint64_t_uint64_t_MutableFirst()

MRC_API MR_uint64_t * MR_std_pair_uint64_t_uint64_t_MutableFirst

(

MR_std_pair_uint64_t_uint64_t *

_this

)

The first of the two elements, 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.

MR_std_pair_uint64_t_uint64_t_MutableSecond()

MRC_API MR_uint64_t * MR_std_pair_uint64_t_uint64_t_MutableSecond

(

MR_std_pair_uint64_t_uint64_t *

_this

)

The second of the two elements, 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.

MR_std_pair_uint64_t_uint64_t_OffsetMutablePtr()

MRC_API MR_std_pair_uint64_t_uint64_t * MR_std_pair_uint64_t_uint64_t_OffsetMutablePtr	(	MR_std_pair_uint64_t_uint64_t *	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_pair_uint64_t_uint64_t_OffsetPtr()

MRC_API const MR_std_pair_uint64_t_uint64_t * MR_std_pair_uint64_t_uint64_t_OffsetPtr	(	const MR_std_pair_uint64_t_uint64_t *	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_pair_uint64_t_uint64_t_Second()

MRC_API const MR_uint64_t * MR_std_pair_uint64_t_uint64_t_Second

(

const MR_std_pair_uint64_t_uint64_t *

_this

)

The second of the two elements, 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.