std_optional_float.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_std_optional_float	MR_std_optional_float

Functions
MRC_API MR_std_optional_float *	MR_std_optional_float_DefaultConstruct (void)
MRC_API MR_std_optional_float *	MR_std_optional_float_DefaultConstructArray (size_t num_elems)
MRC_API MR_std_optional_float *	MR_std_optional_float_ConstructFromAnother (const MR_std_optional_float *other)
MRC_API MR_std_optional_float *	MR_std_optional_float_ConstructFrom (const float *other)
MRC_API void	MR_std_optional_float_AssignFromAnother (MR_std_optional_float *_this, const MR_std_optional_float *other)
MRC_API void	MR_std_optional_float_AssignFrom (MR_std_optional_float *_this, const float *other)
MRC_API void	MR_std_optional_float_Destroy (const MR_std_optional_float *_this)
	Destroys a heap-allocated instance of MR_std_optional_float. Does nothing if the pointer is null.
MRC_API void	MR_std_optional_float_DestroyArray (const MR_std_optional_float *_this)
	Destroys a heap-allocated array of MR_std_optional_float. Does nothing if the pointer is null.
MRC_API const MR_std_optional_float *	MR_std_optional_float_OffsetPtr (const MR_std_optional_float *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_optional_float *	MR_std_optional_float_OffsetMutablePtr (MR_std_optional_float *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 const float *	MR_std_optional_float_Value (const MR_std_optional_float *_this)
MRC_API float *	MR_std_optional_float_MutableValue (MR_std_optional_float *_this)

Typedef Documentation

MR_std_optional_float

typedef struct MR_std_optional_float MR_std_optional_float

Stores either a single float or nothing. 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_optional_float_AssignFrom()

MRC_API void MR_std_optional_float_AssignFrom	(	MR_std_optional_float *	_this,
		const float *	other )

Assigns the contents. Parameter _this can not be null. It is a single object. Parameter other is optional. To keep it empty, pass a null pointer.

MR_std_optional_float_AssignFromAnother()

MRC_API void MR_std_optional_float_AssignFromAnother	(	MR_std_optional_float *	_this,
		const MR_std_optional_float *	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_optional_float_ConstructFrom()

MRC_API MR_std_optional_float * MR_std_optional_float_ConstructFrom

(

const float *

other

)

Constructs a new instance. Parameter other is optional. To keep it empty, pass a null pointer. Never returns null. Returns an instance allocated on the heap! Must call MR_std_optional_float_Destroy() to free it when you're done using it.

MR_std_optional_float_ConstructFromAnother()

MRC_API MR_std_optional_float * MR_std_optional_float_ConstructFromAnother

(

const MR_std_optional_float *

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_optional_float_Destroy() to free it when you're done using it.

MR_std_optional_float_DefaultConstruct()

MRC_API MR_std_optional_float * MR_std_optional_float_DefaultConstruct

(

void

)

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

MR_std_optional_float_DefaultConstructArray()

MRC_API MR_std_optional_float * MR_std_optional_float_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_optional_float_DestroyArray(). Use MR_std_optional_float_OffsetMutablePtr() and MR_std_optional_float_OffsetPtr() to access the array elements.

MR_std_optional_float_Destroy()

MRC_API void MR_std_optional_float_Destroy

(

const MR_std_optional_float *

_this

)

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

MR_std_optional_float_DestroyArray()

MRC_API void MR_std_optional_float_DestroyArray

(

const MR_std_optional_float *

_this

)

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

MR_std_optional_float_MutableValue()

MRC_API float * MR_std_optional_float_MutableValue

(

MR_std_optional_float *

_this

)

The stored element or null if none, mutable. Parameter _this can not be null. It is a single object.

MR_std_optional_float_OffsetMutablePtr()

MRC_API MR_std_optional_float * MR_std_optional_float_OffsetMutablePtr	(	MR_std_optional_float *	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_optional_float_OffsetPtr()

MRC_API const MR_std_optional_float * MR_std_optional_float_OffsetPtr	(	const MR_std_optional_float *	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_optional_float_Value()

MRC_API const float * MR_std_optional_float_Value

(

const MR_std_optional_float *

_this

)

The stored element or null if none, read-only. Parameter _this can not be null. It is a single object.