std_function_void_from_MR_EdgeId_MR_EdgeId.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_EdgeId	MR_EdgeId
typedef struct MR_std_function_void_from_MR_EdgeId_MR_EdgeId	MR_std_function_void_from_MR_EdgeId_MR_EdgeId

Functions
MRC_API MR_std_function_void_from_MR_EdgeId_MR_EdgeId *	MR_std_function_void_from_MR_EdgeId_MR_EdgeId_DefaultConstruct (void)
MRC_API MR_std_function_void_from_MR_EdgeId_MR_EdgeId *	MR_std_function_void_from_MR_EdgeId_MR_EdgeId_DefaultConstructArray (size_t num_elems)
MRC_API MR_std_function_void_from_MR_EdgeId_MR_EdgeId *	MR_std_function_void_from_MR_EdgeId_MR_EdgeId_ConstructFromAnother (MR_PassBy other_pass_by, MR_std_function_void_from_MR_EdgeId_MR_EdgeId *other)
MRC_API void	MR_std_function_void_from_MR_EdgeId_MR_EdgeId_AssignFromAnother (MR_std_function_void_from_MR_EdgeId_MR_EdgeId *_this, MR_PassBy other_pass_by, MR_std_function_void_from_MR_EdgeId_MR_EdgeId *other)
MRC_API void	MR_std_function_void_from_MR_EdgeId_MR_EdgeId_Destroy (const MR_std_function_void_from_MR_EdgeId_MR_EdgeId *_this)
	Destroys a heap-allocated instance of MR_std_function_void_from_MR_EdgeId_MR_EdgeId. Does nothing if the pointer is null.
MRC_API void	MR_std_function_void_from_MR_EdgeId_MR_EdgeId_DestroyArray (const MR_std_function_void_from_MR_EdgeId_MR_EdgeId *_this)
	Destroys a heap-allocated array of MR_std_function_void_from_MR_EdgeId_MR_EdgeId. Does nothing if the pointer is null.
MRC_API const MR_std_function_void_from_MR_EdgeId_MR_EdgeId *	MR_std_function_void_from_MR_EdgeId_MR_EdgeId_OffsetPtr (const MR_std_function_void_from_MR_EdgeId_MR_EdgeId *ptr, ptrdiff_t i)
MRC_API MR_std_function_void_from_MR_EdgeId_MR_EdgeId *	MR_std_function_void_from_MR_EdgeId_MR_EdgeId_OffsetMutablePtr (MR_std_function_void_from_MR_EdgeId_MR_EdgeId *ptr, ptrdiff_t i)
MRC_API MR_std_function_void_from_MR_EdgeId_MR_EdgeId *	MR_std_function_void_from_MR_EdgeId_MR_EdgeId_ConstructStateless (void(*func)(MR_EdgeId *_1, MR_EdgeId *_2))
MRC_API void	MR_std_function_void_from_MR_EdgeId_MR_EdgeId_Assign (MR_std_function_void_from_MR_EdgeId_MR_EdgeId *_this, void(*func)(MR_EdgeId *_1, MR_EdgeId *_2))
MRC_API MR_std_function_void_from_MR_EdgeId_MR_EdgeId *	MR_std_function_void_from_MR_EdgeId_MR_EdgeId_ConstructWithDataPtr (void(*func)(MR_EdgeId *_1, MR_EdgeId *_2, void *_userdata), void *userdata, void(*userdata_callback)(void **_this_userdata, void *_other_userdata))
MRC_API void	MR_std_function_void_from_MR_EdgeId_MR_EdgeId_AssignWithDataPtr (MR_std_function_void_from_MR_EdgeId_MR_EdgeId *_this, void(*func)(MR_EdgeId *_1, MR_EdgeId *_2, void *_userdata), void *userdata, void(*userdata_callback)(void **_this_userdata, void *_other_userdata))

Typedef Documentation

MR_EdgeId

typedef struct MR_EdgeId MR_EdgeId

MR_std_function_void_from_MR_EdgeId_MR_EdgeId

typedef struct MR_std_function_void_from_MR_EdgeId_MR_EdgeId MR_std_function_void_from_MR_EdgeId_MR_EdgeId

Stores a functor of type: void(MR::EdgeId, MR::EdgeId). Possibly stateful. 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_function_void_from_MR_EdgeId_MR_EdgeId_Assign()

MRC_API void MR_std_function_void_from_MR_EdgeId_MR_EdgeId_Assign	(	MR_std_function_void_from_MR_EdgeId_MR_EdgeId *	_this,
		void(*	func )(MR_EdgeId *_1, MR_EdgeId *_2) )

Assign a stateless function. Parameter _this can not be null. It is a single object. Callback parameter _1 will never be null. It is non-owning, do NOT destroy it. In C++ that parameter is an rvalue reference. Callback parameter _2 will never be null. It is non-owning, do NOT destroy it. In C++ that parameter is an rvalue reference.

MR_std_function_void_from_MR_EdgeId_MR_EdgeId_AssignFromAnother()

MRC_API void MR_std_function_void_from_MR_EdgeId_MR_EdgeId_AssignFromAnother	(	MR_std_function_void_from_MR_EdgeId_MR_EdgeId *	_this,
		MR_PassBy	other_pass_by,
		MR_std_function_void_from_MR_EdgeId_MR_EdgeId *	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 had previously.

MR_std_function_void_from_MR_EdgeId_MR_EdgeId_AssignWithDataPtr()

MRC_API void MR_std_function_void_from_MR_EdgeId_MR_EdgeId_AssignWithDataPtr	(	MR_std_function_void_from_MR_EdgeId_MR_EdgeId *	_this,
		void(*	func )(MR_EdgeId *_1, MR_EdgeId *_2, void *_userdata),
		void *	userdata,
		void(*	userdata_callback )(void **_this_userdata, void *_other_userdata) )

Assign a function with an extra user data pointer. Parameter _this can not be null. It is a single object. The reference to the parameter userdata might be preserved in this object. When this function is called, this object will drop any object references it had previously. Callback parameter _1 will never be null. It is non-owning, do NOT destroy it. In C++ that parameter is an rvalue reference. Callback parameter _2 will never be null. It is non-owning, do NOT destroy it. In C++ that parameter is an rvalue reference. Parameter userdata_callback can be null. Pass null if you don't need custom behavior when destroying and/or copying the functor. How to use userdata_callback: The _this_userdata parameter will never be null. If *_this_userdata is non-null and _other_userdata is null, the functor is being destroyed. Perform any cleanup if needed. If *_this_userdata is null and _other_userdata is non-null, a copy of the functor is being constructed. Perform copying if needed and write the new userdata to *_this_userdata. If *_this_userdata is non-null and _other_userdata is non-null, the functor is being assigned. The simplest option is to destroy *_this_userdata first, and then behave as if it was null.

MR_std_function_void_from_MR_EdgeId_MR_EdgeId_ConstructFromAnother()

MRC_API MR_std_function_void_from_MR_EdgeId_MR_EdgeId * MR_std_function_void_from_MR_EdgeId_MR_EdgeId_ConstructFromAnother	(	MR_PassBy	other_pass_by,
		MR_std_function_void_from_MR_EdgeId_MR_EdgeId *	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_function_void_from_MR_EdgeId_MR_EdgeId_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_function_void_from_MR_EdgeId_MR_EdgeId_ConstructStateless()

MRC_API MR_std_function_void_from_MR_EdgeId_MR_EdgeId * MR_std_function_void_from_MR_EdgeId_MR_EdgeId_ConstructStateless

(

void(*

func )(MR_EdgeId *_1, MR_EdgeId *_2)

)

Construct a stateless function. Never returns null. Returns an instance allocated on the heap! Must call MR_std_function_void_from_MR_EdgeId_MR_EdgeId_Destroy() to free it when you're done using it. Callback parameter _1 will never be null. It is non-owning, do NOT destroy it. In C++ that parameter is an rvalue reference. Callback parameter _2 will never be null. It is non-owning, do NOT destroy it. In C++ that parameter is an rvalue reference.

MR_std_function_void_from_MR_EdgeId_MR_EdgeId_ConstructWithDataPtr()

MRC_API MR_std_function_void_from_MR_EdgeId_MR_EdgeId * MR_std_function_void_from_MR_EdgeId_MR_EdgeId_ConstructWithDataPtr	(	void(*	func )(MR_EdgeId *_1, MR_EdgeId *_2, void *_userdata),
		void *	userdata,
		void(*	userdata_callback )(void **_this_userdata, void *_other_userdata) )

Construct a function with an extra user data pointer. The reference to the parameter userdata might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_function_void_from_MR_EdgeId_MR_EdgeId_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. Callback parameter _1 will never be null. It is non-owning, do NOT destroy it. In C++ that parameter is an rvalue reference. Callback parameter _2 will never be null. It is non-owning, do NOT destroy it. In C++ that parameter is an rvalue reference. Parameter userdata_callback can be null. Pass null if you don't need custom behavior when destroying and/or copying the functor. How to use userdata_callback: The _this_userdata parameter will never be null. If *_this_userdata is non-null and _other_userdata is null, the functor is being destroyed. Perform any cleanup if needed. If *_this_userdata is null and _other_userdata is non-null, a copy of the functor is being constructed. Perform copying if needed and write the new userdata to *_this_userdata. If *_this_userdata is non-null and _other_userdata is non-null, the functor is being assigned. The simplest option is to destroy *_this_userdata first, and then behave as if it was null.

MR_std_function_void_from_MR_EdgeId_MR_EdgeId_DefaultConstruct()

MRC_API MR_std_function_void_from_MR_EdgeId_MR_EdgeId * MR_std_function_void_from_MR_EdgeId_MR_EdgeId_DefaultConstruct

(

void

)

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

MR_std_function_void_from_MR_EdgeId_MR_EdgeId_DefaultConstructArray()

MRC_API MR_std_function_void_from_MR_EdgeId_MR_EdgeId * MR_std_function_void_from_MR_EdgeId_MR_EdgeId_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_function_void_from_MR_EdgeId_MR_EdgeId_DestroyArray(). Use MR_std_function_void_from_MR_EdgeId_MR_EdgeId_OffsetMutablePtr() and MR_std_function_void_from_MR_EdgeId_MR_EdgeId_OffsetPtr() to access the array elements.

MR_std_function_void_from_MR_EdgeId_MR_EdgeId_Destroy()

MRC_API void MR_std_function_void_from_MR_EdgeId_MR_EdgeId_Destroy

(

const MR_std_function_void_from_MR_EdgeId_MR_EdgeId *

_this

)

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

MR_std_function_void_from_MR_EdgeId_MR_EdgeId_DestroyArray()

MRC_API void MR_std_function_void_from_MR_EdgeId_MR_EdgeId_DestroyArray

(

const MR_std_function_void_from_MR_EdgeId_MR_EdgeId *

_this

)

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

MR_std_function_void_from_MR_EdgeId_MR_EdgeId_OffsetMutablePtr()

MRC_API MR_std_function_void_from_MR_EdgeId_MR_EdgeId * MR_std_function_void_from_MR_EdgeId_MR_EdgeId_OffsetMutablePtr	(	MR_std_function_void_from_MR_EdgeId_MR_EdgeId *	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_function_void_from_MR_EdgeId_MR_EdgeId_OffsetPtr()

MRC_API const MR_std_function_void_from_MR_EdgeId_MR_EdgeId * MR_std_function_void_from_MR_EdgeId_MR_EdgeId_OffsetPtr	(	const MR_std_function_void_from_MR_EdgeId_MR_EdgeId *	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.