tfC_util.h File Reference

#include "tf_port_c.h"

Include dependency graph for tfC_util.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	tfPointsTypeHandle

Functions
HRESULT	tfPointsType_init (struct tfPointsTypeHandle *handle)
	Initialize an instance.
HRESULT	tfGetSeed (unsigned int *seed)
	Get the current seed for the pseudo-random number generator.
HRESULT	tfSetSeed (unsigned int seed)
	Set the current seed for the pseudo-random number generator.
HRESULT	tfColor3Names (char ***names, unsigned int *numNames)
	Get the names of all available colors.
HRESULT	tfPlaneEquationFPN (tfFloatP_t *point, tfFloatP_t *normal, tfFloatP_t **planeEq)
	Calculate the coefficients of a plane equation from a point and normal of the plane.
HRESULT	tfPlaneEquationTPN (tfFloatP_t *planeEq, tfFloatP_t **point, tfFloatP_t **normal)
	Calculate a point and normal of a plane equation.
HRESULT	tfRandomPoint (unsigned int kind, tfFloatP_t dr, tfFloatP_t phi0, tfFloatP_t phi1, tfFloatP_t *x, tfFloatP_t *y, tfFloatP_t *z)
	Get the coordinates of a random point in a kind of shape.
HRESULT	tfRandomPoints (unsigned int kind, int n, tfFloatP_t dr, tfFloatP_t phi0, tfFloatP_t phi1, tfFloatP_t **x)
	Get the coordinates of random points in a kind of shape.
HRESULT	tfPoints (unsigned int kind, int n, tfFloatP_t **x)
	Get the coordinates of uniform points in a kind of shape.
HRESULT	tfFilledCubeUniform (tfFloatP_t *corner1, tfFloatP_t *corner2, unsigned int nParticlesX, unsigned int nParticlesY, unsigned int nParticlesZ, tfFloatP_t **x)
	Get the coordinates of a uniformly filled cube.
HRESULT	tfFilledCubeRandom (tfFloatP_t *corner1, tfFloatP_t *corner2, int nParticles, tfFloatP_t **x)
	Get the coordinates of a randomly filled cube.
HRESULT	tfIcosphere (unsigned int subdivisions, tfFloatP_t phi0, tfFloatP_t phi1, tfFloatP_t **verts, unsigned int *numVerts, int **inds, unsigned int *numInds)
	Get the coordinates of an icosphere.
HRESULT	tfRandomVector (tfFloatP_t mean, tfFloatP_t std, tfFloatP_t *x, tfFloatP_t *y, tfFloatP_t *z)
	Generates a randomly oriented vector with random magnitude with given mean and standard deviation according to a normal distribution.
HRESULT	tfRandomUnitVector (tfFloatP_t *x, tfFloatP_t *y, tfFloatP_t *z)
	Generates a randomly oriented unit vector.
HRESULT	tfUtilGetFeaturesMap (char ***names, bool **flags, unsigned int *numFeatures)
	Get the compiler features names and flags.
HRESULT	tfUtilWallTime (double *wtime)
	Get the current wall time.
HRESULT	tfUtilCPUTime (double *cputime)
	Get the current CPU time.

Function Documentation

tfColor3Names()

HRESULT tfColor3Names	(	char ***	names,
		unsigned int *	numNames )

Get the names of all available colors.

Returns

S_OK on success

tfFilledCubeRandom()

HRESULT tfFilledCubeRandom	(	tfFloatP_t *	corner1,
		tfFloatP_t *	corner2,
		int	nParticles,
		tfFloatP_t **	x )

Get the coordinates of a randomly filled cube.

Parameters

corner1	first corner of cube
corner2	second corner of cube
nParticles	number of points in the cube
x	coordinates of points

Returns

S_OK on success

tfFilledCubeUniform()

HRESULT tfFilledCubeUniform	(	tfFloatP_t *	corner1,
		tfFloatP_t *	corner2,
		unsigned int	nParticlesX,
		unsigned int	nParticlesY,
		unsigned int	nParticlesZ,
		tfFloatP_t **	x )

Get the coordinates of a uniformly filled cube.

Parameters

corner1	first corner of cube
corner2	second corner of cube
nParticlesX	number of particles along x-direction of filling axes (>=2)
nParticlesY	number of particles along y-direction of filling axes (>=2)
nParticlesZ	number of particles along z-direction of filling axes (>=2)
x	coordinates of points

Returns

S_OK on success

tfIcosphere()

HRESULT tfIcosphere	(	unsigned int	subdivisions,
		tfFloatP_t	phi0,
		tfFloatP_t	phi1,
		tfFloatP_t **	verts,
		unsigned int *	numVerts,
		int **	inds,
		unsigned int *	numInds )

Get the coordinates of an icosphere.

Parameters

subdivisions	number of subdivisions
phi0	angle lower bound
phi1	angle upper bound
verts	returned vertices
numVerts	number of vertices
inds	returned indices
numInds	number of indices

Returns

S_OK on success

tfPlaneEquationFPN()

HRESULT tfPlaneEquationFPN	(	tfFloatP_t *	point,
		tfFloatP_t *	normal,
		tfFloatP_t **	planeEq )

Calculate the coefficients of a plane equation from a point and normal of the plane.

Parameters

point	point on the plane
normal	normal of the plane
planeEq	plane equation coefficients

Returns

S_OK on success

tfPlaneEquationTPN()

HRESULT tfPlaneEquationTPN	(	tfFloatP_t *	planeEq,
		tfFloatP_t **	point,
		tfFloatP_t **	normal )

Calculate a point and normal of a plane equation.

Parameters

planeEq	coefficients of the plane equation
point	point on the plane
normal	normal of the plane

Returns

S_OK on success

tfPoints()

HRESULT tfPoints	(	unsigned int	kind,
		int	n,
		tfFloatP_t **	x )

Get the coordinates of uniform points in a kind of shape.

Currently supports ring and sphere.

Parameters

kind	kind of shape
n	number of points
x	coordinates of points

Returns

S_OK on success

tfPointsType_init()

HRESULT tfPointsType_init

(

struct tfPointsTypeHandle *

handle

)

Initialize an instance.

Parameters

handle

handle to populate

Returns

S_OK on success

tfRandomPoint()

HRESULT tfRandomPoint	(	unsigned int	kind,
		tfFloatP_t	dr,
		tfFloatP_t	phi0,
		tfFloatP_t	phi1,
		tfFloatP_t *	x,
		tfFloatP_t *	y,
		tfFloatP_t *	z )

Get the coordinates of a random point in a kind of shape.

Currently supports sphere, disk, solid cube and solid sphere.

Parameters

kind	kind of shape
dr	thickness parameter; only applicable to solid sphere kind
phi0	angle lower bound; only applicable to solid sphere kind
phi1	angle upper bound; only applicable to solid sphere kind
x	x-coordinate of random point
y	y-coordinate of random point
z	z-coordinate of random point

Returns

S_OK on success

tfRandomPoints()

HRESULT tfRandomPoints	(	unsigned int	kind,
		int	n,
		tfFloatP_t	dr,
		tfFloatP_t	phi0,
		tfFloatP_t	phi1,
		tfFloatP_t **	x )

Get the coordinates of random points in a kind of shape.

Currently supports sphere, disk, solid cube and solid sphere.

Parameters

kind	kind of shape
n	number of points
dr	thickness parameter; only applicable to solid sphere kind
phi0	angle lower bound; only applicable to solid sphere kind
phi1	angle upper bound; only applicable to solid sphere kind
x	coordinates of random points

Returns

S_OK on success

tfRandomUnitVector()

HRESULT tfRandomUnitVector	(	tfFloatP_t *	x,
		tfFloatP_t *	y,
		tfFloatP_t *	z )

Generates a randomly oriented unit vector.

Parameters

x	x-component of vector
y	y-component of vector
z	z-component of vector

Returns

S_OK on success

tfRandomVector()

HRESULT tfRandomVector	(	tfFloatP_t	mean,
		tfFloatP_t	std,
		tfFloatP_t *	x,
		tfFloatP_t *	y,
		tfFloatP_t *	z )

Generates a randomly oriented vector with random magnitude with given mean and standard deviation according to a normal distribution.

Parameters

mean	magnitude mean
std	magnitude standard deviation
x	x-component of vector
y	y-component of vector
z	z-component of vector

Returns

S_OK on success

tfSetSeed()

HRESULT tfSetSeed

(

unsigned int

seed

)

Set the current seed for the pseudo-random number generator.

Parameters

seed	new seed value

Returns

S_OK on success

tfUtilCPUTime()

HRESULT tfUtilCPUTime

(

double *

cputime

)

Get the current CPU time.

Parameters

cputime

CPU time

Returns

S_OK on success

tfUtilGetFeaturesMap()

HRESULT tfUtilGetFeaturesMap	(	char ***	names,
		bool **	flags,
		unsigned int *	numFeatures )

Get the compiler features names and flags.

Parameters

names	feature names
flags	feature flags
numFeatures	number of features

Returns

S_OK on success

tfUtilWallTime()

HRESULT tfUtilWallTime

(

double *

wtime

)

Get the current wall time.

Parameters

wtime

wall time

Returns

S_OK on success