fields::field_ed_algebra Namespace Reference

Namespace containing the algrebra functions for a field with a property section of type sec_ed. More...

Functions
void SHEAF_DLL_SPEC	dot (const field_ed &x0, const field_ed &x1, field_at0 &xresult, bool xauto_access)
	The Euclidean "dot" product of x0 with x2. More...
void SHEAF_DLL_SPEC	length (const field_ed &x0, field_at0 &xresult, bool xauto_access)
	The Euclidean length (magnitude) of x0. More...
void SHEAF_DLL_SPEC	put_length (field_ed &x0, const vd_value_type &xlength, bool xauto_access)
	Set the Euclidean length (magnitude) of x0 to xlength. More...
void SHEAF_DLL_SPEC	normalize (const field_ed &x0, field_ed &xresult, bool xauto_access)
	Normalize x0 (convert to a unit vector). More...
void SHEAF_DLL_SPEC	normalize (field_ed &x0, bool xauto_access)
	Normalize x0 (convert to a unit vector) in place; synonym for normalize(x0, x0, xauto_access). More...

Detailed Description

Namespace containing the algrebra functions for a field with a property section of type sec_ed.

Function Documentation

dot()

void fields::field_ed_algebra::dot	(	const field_ed &	x0,
		const field_ed &	x1,
		field_at0 &	xresult,
		bool	xauto_access
	)

The Euclidean "dot" product of x0 with x2.

Implementation for field_ed algebra functions.

Precondition

• precondition_of(\ dot(x0.property(), x1.property(), xresult.property(), xauto_access))

Postcondition

• postcondition_of(\ dot(x0.property(), x1.property(), xresult.property(), xauto_access))

Definition at line 32 of file field_ed_funcs.impl.h.

References fiber_bundle::sec_ed_algebra::dot(), fiber_bundle::ed_algebra::dot(), length(), fields::field_at0::property(), and fields::field_ed::property().

length()

void fields::field_ed_algebra::length	(	const field_ed &	x0,
		field_at0 &	xresult,
		bool	xauto_access
	)

The Euclidean length (magnitude) of x0.

Precondition

• precondition_of(\ length(x0.property(), xresult.property(), xauto_access))

Postcondition

• postcondition_of(\ length(x0.property(), xresult.property(), xauto_access))

Definition at line 57 of file field_ed_funcs.impl.h.

References fiber_bundle::sec_ed_algebra::length(), fiber_bundle::ed_algebra::length(), fields::field_ed::property(), fields::field_at0::property(), and put_length().

Referenced by dot().

normalize() [1/2]

void fields::field_ed_algebra::normalize	(	const field_ed &	x0,
		field_ed &	xresult,
		bool	xauto_access
	)

Normalize x0 (convert to a unit vector).

Precondition

• precondition_of(\ normalize(x0.property(), xresult.property(), xauto_access))

Postcondition

• postcondition_of(\ normalize(x0.property(), xresult.property(), xauto_access))

Definition at line 105 of file field_ed_funcs.impl.h.

References fiber_bundle::sec_ed_algebra::normalize(), fiber_bundle::ed_algebra::normalize(), and fields::field_ed::property().

Referenced by put_length().

normalize() [2/2]

void fields::field_ed_algebra::normalize	(	field_ed &	x0,
		bool	xauto_access
	)

Normalize x0 (convert to a unit vector) in place; synonym for normalize(x0, x0, xauto_access).

Precondition

• precondition_of(\ normalize(x0.property(), xauto_access))

Postcondition

• postcondition_of(\ normalize(x0.property(), xauto_access))

Definition at line 129 of file field_ed_funcs.impl.h.

References fiber_bundle::sec_ed_algebra::normalize(), fiber_bundle::ed_algebra::normalize(), and fields::field_ed::property().

put_length()

void fields::field_ed_algebra::put_length	(	field_ed &	x0,
		const vd_value_type &	xlength,
		bool	xauto_access
	)

Set the Euclidean length (magnitude) of x0 to xlength.

Precondition

• precondition_of(\ put_length(x0.property(), xlength, xauto_access))

Postcondition

• postcondition_of(\ put_length(x0.property(), xlength, xauto_access))

Definition at line 81 of file field_ed_funcs.impl.h.

References normalize(), fields::field_ed::property(), fiber_bundle::sec_ed_algebra::put_length(), and fiber_bundle::ed_algebra::put_length().

Referenced by length().