std_pair_double_int.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_std_pair_double_int	MR_std_pair_double_int

Functions
MRC_API MR_std_pair_double_int *	MR_std_pair_double_int_DefaultConstruct (void)
MRC_API MR_std_pair_double_int *	MR_std_pair_double_int_DefaultConstructArray (size_t num_elems)
MRC_API MR_std_pair_double_int *	MR_std_pair_double_int_ConstructFromAnother (const MR_std_pair_double_int *other)
MRC_API void	MR_std_pair_double_int_AssignFromAnother (MR_std_pair_double_int *_this, const MR_std_pair_double_int *other)
MRC_API void	MR_std_pair_double_int_Destroy (const MR_std_pair_double_int *_this)
	Destroys a heap-allocated instance of MR_std_pair_double_int. Does nothing if the pointer is null.
MRC_API void	MR_std_pair_double_int_DestroyArray (const MR_std_pair_double_int *_this)
	Destroys a heap-allocated array of MR_std_pair_double_int. Does nothing if the pointer is null.
MRC_API const MR_std_pair_double_int *	MR_std_pair_double_int_OffsetPtr (const MR_std_pair_double_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.
MRC_API MR_std_pair_double_int *	MR_std_pair_double_int_OffsetMutablePtr (MR_std_pair_double_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.
MRC_API MR_std_pair_double_int *	MR_std_pair_double_int_Construct (double first, int second)
MRC_API const double *	MR_std_pair_double_int_First (const MR_std_pair_double_int *_this)
MRC_API double *	MR_std_pair_double_int_MutableFirst (MR_std_pair_double_int *_this)
MRC_API const int *	MR_std_pair_double_int_Second (const MR_std_pair_double_int *_this)
MRC_API int *	MR_std_pair_double_int_MutableSecond (MR_std_pair_double_int *_this)

Typedef Documentation

MR_std_pair_double_int

typedef struct MR_std_pair_double_int MR_std_pair_double_int

Stores two objects: double and double. 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_double_int_AssignFromAnother()

MRC_API void MR_std_pair_double_int_AssignFromAnother	(	MR_std_pair_double_int *	_this,
		const MR_std_pair_double_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. Parameter other can not be null. It is a single object.

MR_std_pair_double_int_Construct()

MRC_API MR_std_pair_double_int * MR_std_pair_double_int_Construct	(	double	first,
		int	second )

Constructs the pair elementwise. Never returns null. Returns an instance allocated on the heap! Must call MR_std_pair_double_int_Destroy() to free it when you're done using it.

MR_std_pair_double_int_ConstructFromAnother()

MRC_API MR_std_pair_double_int * MR_std_pair_double_int_ConstructFromAnother

(

const MR_std_pair_double_int *

other

)

Constructs a copy of another instance. The source remains alive. Parameter other can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_pair_double_int_Destroy() to free it when you're done using it.

MR_std_pair_double_int_DefaultConstruct()

MRC_API MR_std_pair_double_int * MR_std_pair_double_int_DefaultConstruct

(

void

)

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

MR_std_pair_double_int_DefaultConstructArray()

MRC_API MR_std_pair_double_int * MR_std_pair_double_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_pair_double_int_DestroyArray(). Use MR_std_pair_double_int_OffsetMutablePtr() and MR_std_pair_double_int_OffsetPtr() to access the array elements.

MR_std_pair_double_int_Destroy()

MRC_API void MR_std_pair_double_int_Destroy

(

const MR_std_pair_double_int *

_this

)

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

MR_std_pair_double_int_DestroyArray()

MRC_API void MR_std_pair_double_int_DestroyArray

(

const MR_std_pair_double_int *

_this

)

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

MR_std_pair_double_int_First()

MRC_API const double * MR_std_pair_double_int_First

(

const MR_std_pair_double_int *

_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_double_int_MutableFirst()

MRC_API double * MR_std_pair_double_int_MutableFirst

(

MR_std_pair_double_int *

_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_double_int_MutableSecond()

MRC_API int * MR_std_pair_double_int_MutableSecond

(

MR_std_pair_double_int *

_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_double_int_OffsetMutablePtr()

MRC_API MR_std_pair_double_int * MR_std_pair_double_int_OffsetMutablePtr	(	MR_std_pair_double_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.

MR_std_pair_double_int_OffsetPtr()

MRC_API const MR_std_pair_double_int * MR_std_pair_double_int_OffsetPtr	(	const MR_std_pair_double_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.

MR_std_pair_double_int_Second()

MRC_API const int * MR_std_pair_double_int_Second

(

const MR_std_pair_double_int *

_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.