MRBestFitParabola.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_Parabolad	MR_Parabolad
typedef struct MR_Parabolaf	MR_Parabolaf
typedef struct MR_BestFitParabolaf	MR_BestFitParabolaf
typedef struct MR_BestFitParabolad	MR_BestFitParabolad

Functions
MRC_API MR_BestFitParabolaf *	MR_BestFitParabolaf_DefaultConstruct (void)
MRC_API MR_BestFitParabolaf *	MR_BestFitParabolaf_DefaultConstructArray (size_t num_elems)
MRC_API const MR_BestFitParabolaf *	MR_BestFitParabolaf_OffsetPtr (const MR_BestFitParabolaf *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_BestFitParabolaf *	MR_BestFitParabolaf_OffsetMutablePtr (MR_BestFitParabolaf *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_BestFitParabolaf *	MR_BestFitParabolaf_ConstructFromAnother (const MR_BestFitParabolaf *_other)
MRC_API void	MR_BestFitParabolaf_Destroy (const MR_BestFitParabolaf *_this)
	Destroys a heap-allocated instance of MR_BestFitParabolaf. Does nothing if the pointer is null.
MRC_API void	MR_BestFitParabolaf_DestroyArray (const MR_BestFitParabolaf *_this)
	Destroys a heap-allocated array of MR_BestFitParabolaf. Does nothing if the pointer is null.
MRC_API MR_BestFitParabolaf *	MR_BestFitParabolaf_AssignFromAnother (MR_BestFitParabolaf *_this, const MR_BestFitParabolaf *_other)
MRC_API void	MR_BestFitParabolaf_addPoint_2 (MR_BestFitParabolaf *_this, float x, float y)
MRC_API void	MR_BestFitParabolaf_addPoint_3 (MR_BestFitParabolaf *_this, float x, float y, float weight)
MRC_API MR_Parabolaf *	MR_BestFitParabolaf_getBestParabola (const MR_BestFitParabolaf *_this, const float *tol)
MRC_API MR_BestFitParabolad *	MR_BestFitParabolad_DefaultConstruct (void)
MRC_API MR_BestFitParabolad *	MR_BestFitParabolad_DefaultConstructArray (size_t num_elems)
MRC_API const MR_BestFitParabolad *	MR_BestFitParabolad_OffsetPtr (const MR_BestFitParabolad *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_BestFitParabolad *	MR_BestFitParabolad_OffsetMutablePtr (MR_BestFitParabolad *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_BestFitParabolad *	MR_BestFitParabolad_ConstructFromAnother (const MR_BestFitParabolad *_other)
MRC_API void	MR_BestFitParabolad_Destroy (const MR_BestFitParabolad *_this)
	Destroys a heap-allocated instance of MR_BestFitParabolad. Does nothing if the pointer is null.
MRC_API void	MR_BestFitParabolad_DestroyArray (const MR_BestFitParabolad *_this)
	Destroys a heap-allocated array of MR_BestFitParabolad. Does nothing if the pointer is null.
MRC_API MR_BestFitParabolad *	MR_BestFitParabolad_AssignFromAnother (MR_BestFitParabolad *_this, const MR_BestFitParabolad *_other)
MRC_API void	MR_BestFitParabolad_addPoint_2 (MR_BestFitParabolad *_this, double x, double y)
MRC_API void	MR_BestFitParabolad_addPoint_3 (MR_BestFitParabolad *_this, double x, double y, double weight)
MRC_API MR_Parabolad *	MR_BestFitParabolad_getBestParabola (const MR_BestFitParabolad *_this, const double *tol)

Typedef Documentation

MR_BestFitParabolad

typedef struct MR_BestFitParabolad MR_BestFitParabolad

accumulates a number of (x,y) points to find the best-least-squares parabola approximating them Generated from class MR::BestFitParabolad.

MR_BestFitParabolaf

typedef struct MR_BestFitParabolaf MR_BestFitParabolaf

accumulates a number of (x,y) points to find the best-least-squares parabola approximating them Generated from class MR::BestFitParabolaf.

MR_Parabolad

typedef struct MR_Parabolad MR_Parabolad

MR_Parabolaf

typedef struct MR_Parabolaf MR_Parabolaf

Function Documentation

MR_BestFitParabolad_addPoint_2()

MRC_API void MR_BestFitParabolad_addPoint_2	(	MR_BestFitParabolad *	_this,
		double	x,
		double	y )

accumulates one more point for parabola fitting Generated from a method of class MR::BestFitParabolad named addPoint. Parameter _this can not be null. It is a single object.

MR_BestFitParabolad_addPoint_3()

MRC_API void MR_BestFitParabolad_addPoint_3	(	MR_BestFitParabolad *	_this,
		double	x,
		double	y,
		double	weight )

accumulates one more point with given weight for parabola fitting Generated from a method of class MR::BestFitParabolad named addPoint. Parameter _this can not be null. It is a single object.

MR_BestFitParabolad_AssignFromAnother()

MRC_API MR_BestFitParabolad * MR_BestFitParabolad_AssignFromAnother	(	MR_BestFitParabolad *	_this,
		const MR_BestFitParabolad *	_other )

Generated from a method of class MR::BestFitParabolad named operator=. Parameter _this can not be null. It is a single object. Parameter _other 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_BestFitParabolad_ConstructFromAnother()

MRC_API MR_BestFitParabolad * MR_BestFitParabolad_ConstructFromAnother

(

const MR_BestFitParabolad *

_other

)

Generated from a constructor of class MR::BestFitParabolad. Parameter _other can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_BestFitParabolad_Destroy() to free it when you're done using it.

MR_BestFitParabolad_DefaultConstruct()

MRC_API MR_BestFitParabolad * MR_BestFitParabolad_DefaultConstruct

(

void

)

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

MR_BestFitParabolad_DefaultConstructArray()

MRC_API MR_BestFitParabolad * MR_BestFitParabolad_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_BestFitParabolad_DestroyArray(). Use MR_BestFitParabolad_OffsetMutablePtr() and MR_BestFitParabolad_OffsetPtr() to access the array elements.

MR_BestFitParabolad_Destroy()

MRC_API void MR_BestFitParabolad_Destroy

(

const MR_BestFitParabolad *

_this

)

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

MR_BestFitParabolad_DestroyArray()

MRC_API void MR_BestFitParabolad_DestroyArray

(

const MR_BestFitParabolad *

_this

)

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

MR_BestFitParabolad_getBestParabola()

MRC_API MR_Parabolad * MR_BestFitParabolad_getBestParabola	(	const MR_BestFitParabolad *	_this,
		const double *	tol )

computes the best approximating parabola from the accumulated points; Generated from a method of class MR::BestFitParabolad named getBestParabola. Parameter _this can not be null. It is a single object. Parameter tol has a default argument: std::numeric_limits<double>::epsilon(), pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_Parabolad_Destroy() to free it when you're done using it.

MR_BestFitParabolad_OffsetMutablePtr()

MRC_API MR_BestFitParabolad * MR_BestFitParabolad_OffsetMutablePtr	(	MR_BestFitParabolad *	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_BestFitParabolad_OffsetPtr()

MRC_API const MR_BestFitParabolad * MR_BestFitParabolad_OffsetPtr	(	const MR_BestFitParabolad *	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_BestFitParabolaf_addPoint_2()

MRC_API void MR_BestFitParabolaf_addPoint_2	(	MR_BestFitParabolaf *	_this,
		float	x,
		float	y )

accumulates one more point for parabola fitting Generated from a method of class MR::BestFitParabolaf named addPoint. Parameter _this can not be null. It is a single object.

MR_BestFitParabolaf_addPoint_3()

MRC_API void MR_BestFitParabolaf_addPoint_3	(	MR_BestFitParabolaf *	_this,
		float	x,
		float	y,
		float	weight )

accumulates one more point with given weight for parabola fitting Generated from a method of class MR::BestFitParabolaf named addPoint. Parameter _this can not be null. It is a single object.

MR_BestFitParabolaf_AssignFromAnother()

MRC_API MR_BestFitParabolaf * MR_BestFitParabolaf_AssignFromAnother	(	MR_BestFitParabolaf *	_this,
		const MR_BestFitParabolaf *	_other )

Generated from a method of class MR::BestFitParabolaf named operator=. Parameter _this can not be null. It is a single object. Parameter _other 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_BestFitParabolaf_ConstructFromAnother()

MRC_API MR_BestFitParabolaf * MR_BestFitParabolaf_ConstructFromAnother

(

const MR_BestFitParabolaf *

_other

)

Generated from a constructor of class MR::BestFitParabolaf. Parameter _other can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_BestFitParabolaf_Destroy() to free it when you're done using it.

MR_BestFitParabolaf_DefaultConstruct()

MRC_API MR_BestFitParabolaf * MR_BestFitParabolaf_DefaultConstruct

(

void

)

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

MR_BestFitParabolaf_DefaultConstructArray()

MRC_API MR_BestFitParabolaf * MR_BestFitParabolaf_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_BestFitParabolaf_DestroyArray(). Use MR_BestFitParabolaf_OffsetMutablePtr() and MR_BestFitParabolaf_OffsetPtr() to access the array elements.

MR_BestFitParabolaf_Destroy()

MRC_API void MR_BestFitParabolaf_Destroy

(

const MR_BestFitParabolaf *

_this

)

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

MR_BestFitParabolaf_DestroyArray()

MRC_API void MR_BestFitParabolaf_DestroyArray

(

const MR_BestFitParabolaf *

_this

)

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

MR_BestFitParabolaf_getBestParabola()

MRC_API MR_Parabolaf * MR_BestFitParabolaf_getBestParabola	(	const MR_BestFitParabolaf *	_this,
		const float *	tol )

computes the best approximating parabola from the accumulated points; Generated from a method of class MR::BestFitParabolaf named getBestParabola. Parameter _this can not be null. It is a single object. Parameter tol has a default argument: std::numeric_limits<float>::epsilon(), pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_Parabolaf_Destroy() to free it when you're done using it.

MR_BestFitParabolaf_OffsetMutablePtr()

MRC_API MR_BestFitParabolaf * MR_BestFitParabolaf_OffsetMutablePtr	(	MR_BestFitParabolaf *	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_BestFitParabolaf_OffsetPtr()

MRC_API const MR_BestFitParabolaf * MR_BestFitParabolaf_OffsetPtr	(	const MR_BestFitParabolaf *	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.