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

Typedefs
typedef struct MR_PointsProjectionResult	MR_PointsProjectionResult
typedef struct MR_std_vector_MR_PointsProjectionResult	MR_std_vector_MR_PointsProjectionResult
typedef struct MR_FewSmallest_MR_PointsProjectionResult	MR_FewSmallest_MR_PointsProjectionResult

Functions
MRC_API MR_FewSmallest_MR_PointsProjectionResult *	MR_FewSmallest_MR_PointsProjectionResult_DefaultConstruct (void)
MRC_API MR_FewSmallest_MR_PointsProjectionResult *	MR_FewSmallest_MR_PointsProjectionResult_DefaultConstructArray (size_t num_elems)
MRC_API const MR_FewSmallest_MR_PointsProjectionResult *	MR_FewSmallest_MR_PointsProjectionResult_OffsetPtr (const MR_FewSmallest_MR_PointsProjectionResult *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_FewSmallest_MR_PointsProjectionResult *	MR_FewSmallest_MR_PointsProjectionResult_OffsetMutablePtr (MR_FewSmallest_MR_PointsProjectionResult *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_FewSmallest_MR_PointsProjectionResult *	MR_FewSmallest_MR_PointsProjectionResult_ConstructFromAnother (MR_PassBy _other_pass_by, MR_FewSmallest_MR_PointsProjectionResult *_other)
MRC_API MR_FewSmallest_MR_PointsProjectionResult *	MR_FewSmallest_MR_PointsProjectionResult_Construct (MR_uint64_t maxElms)
MRC_API void	MR_FewSmallest_MR_PointsProjectionResult_Destroy (const MR_FewSmallest_MR_PointsProjectionResult *_this)
	Destroys a heap-allocated instance of MR_FewSmallest_MR_PointsProjectionResult. Does nothing if the pointer is null.
MRC_API void	MR_FewSmallest_MR_PointsProjectionResult_DestroyArray (const MR_FewSmallest_MR_PointsProjectionResult *_this)
	Destroys a heap-allocated array of MR_FewSmallest_MR_PointsProjectionResult. Does nothing if the pointer is null.
MRC_API MR_FewSmallest_MR_PointsProjectionResult *	MR_FewSmallest_MR_PointsProjectionResult_AssignFromAnother (MR_FewSmallest_MR_PointsProjectionResult *_this, MR_PassBy _other_pass_by, MR_FewSmallest_MR_PointsProjectionResult *_other)
MRC_API void	MR_FewSmallest_MR_PointsProjectionResult_reset (MR_FewSmallest_MR_PointsProjectionResult *_this, MR_uint64_t maxElms)
MRC_API MR_uint64_t	MR_FewSmallest_MR_PointsProjectionResult_maxElms (const MR_FewSmallest_MR_PointsProjectionResult *_this)
MRC_API bool	MR_FewSmallest_MR_PointsProjectionResult_empty (const MR_FewSmallest_MR_PointsProjectionResult *_this)
MRC_API MR_uint64_t	MR_FewSmallest_MR_PointsProjectionResult_size (const MR_FewSmallest_MR_PointsProjectionResult *_this)
MRC_API bool	MR_FewSmallest_MR_PointsProjectionResult_full (const MR_FewSmallest_MR_PointsProjectionResult *_this)
MRC_API const MR_std_vector_MR_PointsProjectionResult *	MR_FewSmallest_MR_PointsProjectionResult_get (const MR_FewSmallest_MR_PointsProjectionResult *_this)
MRC_API const MR_PointsProjectionResult *	MR_FewSmallest_MR_PointsProjectionResult_top (const MR_FewSmallest_MR_PointsProjectionResult *_this)
MRC_API const MR_PointsProjectionResult *	MR_FewSmallest_MR_PointsProjectionResult_topOr (const MR_FewSmallest_MR_PointsProjectionResult *_this, const MR_PointsProjectionResult *emptyRes)
MRC_API void	MR_FewSmallest_MR_PointsProjectionResult_push (MR_FewSmallest_MR_PointsProjectionResult *_this, const MR_PointsProjectionResult *t)
MRC_API void	MR_FewSmallest_MR_PointsProjectionResult_clear (MR_FewSmallest_MR_PointsProjectionResult *_this)

Typedef Documentation

MR_FewSmallest_MR_PointsProjectionResult

typedef struct MR_FewSmallest_MR_PointsProjectionResult MR_FewSmallest_MR_PointsProjectionResult

the class stores some number of smallest elements from a larger number of candidates Generated from class MR::FewSmallest<MR::PointsProjectionResult>.

MR_PointsProjectionResult

typedef struct MR_PointsProjectionResult MR_PointsProjectionResult

MR_std_vector_MR_PointsProjectionResult

typedef struct MR_std_vector_MR_PointsProjectionResult MR_std_vector_MR_PointsProjectionResult

Function Documentation

MR_FewSmallest_MR_PointsProjectionResult_AssignFromAnother()

MRC_API MR_FewSmallest_MR_PointsProjectionResult * MR_FewSmallest_MR_PointsProjectionResult_AssignFromAnother	(	MR_FewSmallest_MR_PointsProjectionResult *	_this,
		MR_PassBy	_other_pass_by,
		MR_FewSmallest_MR_PointsProjectionResult *	_other )

Generated from a method of class MR::FewSmallest<MR::PointsProjectionResult> named operator=. 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_FewSmallest_MR_PointsProjectionResult_clear()

MRC_API void MR_FewSmallest_MR_PointsProjectionResult_clear

(

MR_FewSmallest_MR_PointsProjectionResult *

_this

)

removes all stored elements Generated from a method of class MR::FewSmallest<MR::PointsProjectionResult> named clear. Parameter _this can not be null. It is a single object.

MR_FewSmallest_MR_PointsProjectionResult_Construct()

MRC_API MR_FewSmallest_MR_PointsProjectionResult * MR_FewSmallest_MR_PointsProjectionResult_Construct

(

MR_uint64_t

maxElms

)

configure the object to store at most given number of elements Generated from a constructor of class MR::FewSmallest<MR::PointsProjectionResult>. Never returns null. Returns an instance allocated on the heap! Must call MR_FewSmallest_MR_PointsProjectionResult_Destroy() to free it when you're done using it.

MR_FewSmallest_MR_PointsProjectionResult_ConstructFromAnother()

MRC_API MR_FewSmallest_MR_PointsProjectionResult * MR_FewSmallest_MR_PointsProjectionResult_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_FewSmallest_MR_PointsProjectionResult *	_other )

Generated from a constructor of class MR::FewSmallest<MR::PointsProjectionResult>. Never returns null. Returns an instance allocated on the heap! Must call MR_FewSmallest_MR_PointsProjectionResult_Destroy() to free it when you're done using it.

MR_FewSmallest_MR_PointsProjectionResult_DefaultConstruct()

MRC_API MR_FewSmallest_MR_PointsProjectionResult * MR_FewSmallest_MR_PointsProjectionResult_DefaultConstruct

(

void

)

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

MR_FewSmallest_MR_PointsProjectionResult_DefaultConstructArray()

MRC_API MR_FewSmallest_MR_PointsProjectionResult * MR_FewSmallest_MR_PointsProjectionResult_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_FewSmallest_MR_PointsProjectionResult_DestroyArray(). Use MR_FewSmallest_MR_PointsProjectionResult_OffsetMutablePtr() and MR_FewSmallest_MR_PointsProjectionResult_OffsetPtr() to access the array elements.

MR_FewSmallest_MR_PointsProjectionResult_Destroy()

MRC_API void MR_FewSmallest_MR_PointsProjectionResult_Destroy

(

const MR_FewSmallest_MR_PointsProjectionResult *

_this

)

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

MR_FewSmallest_MR_PointsProjectionResult_DestroyArray()

MRC_API void MR_FewSmallest_MR_PointsProjectionResult_DestroyArray

(

const MR_FewSmallest_MR_PointsProjectionResult *

_this

)

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

MR_FewSmallest_MR_PointsProjectionResult_empty()

MRC_API bool MR_FewSmallest_MR_PointsProjectionResult_empty

(

const MR_FewSmallest_MR_PointsProjectionResult *

_this

)

returns whether the container is currently empty Generated from a method of class MR::FewSmallest<MR::PointsProjectionResult> named empty. Parameter _this can not be null. It is a single object.

MR_FewSmallest_MR_PointsProjectionResult_full()

MRC_API bool MR_FewSmallest_MR_PointsProjectionResult_full

(

const MR_FewSmallest_MR_PointsProjectionResult *

_this

)

returns whether we have already maximum number of elements stored Generated from a method of class MR::FewSmallest<MR::PointsProjectionResult> named full. Parameter _this can not be null. It is a single object.

MR_FewSmallest_MR_PointsProjectionResult_get()

MRC_API const MR_std_vector_MR_PointsProjectionResult * MR_FewSmallest_MR_PointsProjectionResult_get

(

const MR_FewSmallest_MR_PointsProjectionResult *

_this

)

returns the smallest elements found so far Generated from a method of class MR::FewSmallest<MR::PointsProjectionResult> named get. 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_FewSmallest_MR_PointsProjectionResult_maxElms()

MRC_API MR_uint64_t MR_FewSmallest_MR_PointsProjectionResult_maxElms

(

const MR_FewSmallest_MR_PointsProjectionResult *

_this

)

returns the maximum number of elements to be stored here Generated from a method of class MR::FewSmallest<MR::PointsProjectionResult> named maxElms. Parameter _this can not be null. It is a single object.

MR_FewSmallest_MR_PointsProjectionResult_OffsetMutablePtr()

MRC_API MR_FewSmallest_MR_PointsProjectionResult * MR_FewSmallest_MR_PointsProjectionResult_OffsetMutablePtr	(	MR_FewSmallest_MR_PointsProjectionResult *	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_FewSmallest_MR_PointsProjectionResult_OffsetPtr()

MRC_API const MR_FewSmallest_MR_PointsProjectionResult * MR_FewSmallest_MR_PointsProjectionResult_OffsetPtr	(	const MR_FewSmallest_MR_PointsProjectionResult *	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_FewSmallest_MR_PointsProjectionResult_push()

MRC_API void MR_FewSmallest_MR_PointsProjectionResult_push	(	MR_FewSmallest_MR_PointsProjectionResult *	_this,
		const MR_PointsProjectionResult *	t )

considers one more element, storing it if it is within the smallest Generated from a method of class MR::FewSmallest<MR::PointsProjectionResult> named push. Parameter _this can not be null. It is a single object. Parameter t can not be null. It is a single object.

MR_FewSmallest_MR_PointsProjectionResult_reset()

MRC_API void MR_FewSmallest_MR_PointsProjectionResult_reset	(	MR_FewSmallest_MR_PointsProjectionResult *	_this,
		MR_uint64_t	maxElms )

clears the content and reconfigure the object to store at most given number of elements Generated from a method of class MR::FewSmallest<MR::PointsProjectionResult> named reset. Parameter _this can not be null. It is a single object.

MR_FewSmallest_MR_PointsProjectionResult_size()

MRC_API MR_uint64_t MR_FewSmallest_MR_PointsProjectionResult_size

(

const MR_FewSmallest_MR_PointsProjectionResult *

_this

)

returns current number of stored element Generated from a method of class MR::FewSmallest<MR::PointsProjectionResult> named size. Parameter _this can not be null. It is a single object.

MR_FewSmallest_MR_PointsProjectionResult_top()

MRC_API const MR_PointsProjectionResult * MR_FewSmallest_MR_PointsProjectionResult_top

(

const MR_FewSmallest_MR_PointsProjectionResult *

_this

)

returns the largest among stored smallest elements Generated from a method of class MR::FewSmallest<MR::PointsProjectionResult> named top. 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_FewSmallest_MR_PointsProjectionResult_topOr()

MRC_API const MR_PointsProjectionResult * MR_FewSmallest_MR_PointsProjectionResult_topOr	(	const MR_FewSmallest_MR_PointsProjectionResult *	_this,
		const MR_PointsProjectionResult *	emptyRes )

returns the largest among stored smallest elements or given element if this is empty Generated from a method of class MR::FewSmallest<MR::PointsProjectionResult> named topOr. Parameter _this can not be null. It is a single object. Parameter emptyRes can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.