fq6.h File Reference

Definition of Fq6 math. More...

#include <stdint.h>

Functions
void	Fq6Add (Fq6Elem *result, Fq6Elem const *left, Fq6Elem const *right)
	Add two elements of Fq6. More...
void	Fq6Sub (Fq6Elem *result, Fq6Elem const *left, Fq6Elem const *right)
	Subtract two elements of Fq6. More...
void	Fq6Mul (Fq6Elem *result, Fq6Elem const *left, Fq6Elem const *right)
	Multiply two elements of Fq6. More...
void	Fq6Inv (Fq6Elem *result, Fq6Elem const *in)
	Invert an element of Fq6. More...
void	Fq6Neg (Fq6Elem *result, Fq6Elem const *in)
	Negate an element of Fq6. More...
void	Fq6Clear (Fq6Elem *result)
	Clear an element's value. More...
void	Fq6MulScalar (Fq6Elem *result, Fq6Elem const *in, Fq2Elem const *scalar)
	Multiply an element of Fq6 by and element of Fq2. More...
void	Fq6MulV (Fq6Elem *result, Fq6Elem const *in)
	Multiply an element of Fq6 by V. More...
int	Fq6Eq (Fq6Elem const *left, Fq6Elem const *right)
	Test if two elements in Fq6 are equal. More...
int	Fq6IsZero (Fq6Elem const *in)
	Test if an element is zero. More...
void	Fq6Square (Fq6Elem *result, Fq6Elem const *in)
	Square an element of Fq6. More...
void	Fq6Cp (Fq6Elem *result, Fq6Elem const *in)
	Copy an element's value. More...
void	Fq6CondSet (Fq6Elem *result, Fq6Elem const *true_val, Fq6Elem const *false_val, int truth_val)
	Conditionally Set an element's value to one of two values. More...
void	Fq6Set (Fq6Elem *result, uint32_t in)
	Set an element's value. More...

Detailed Description

Definition of Fq6 math.

Function Documentation

Fq6Add()

void Fq6Add	(	Fq6Elem *	result,
		Fq6Elem const *	left,
		Fq6Elem const *	right
	)

Add two elements of Fq6.

Parameters

[out]	result	of adding left and right.
[in]	left	The first operand to be added.
[in]	right	The second operand to be added.

Fq6Clear()

void Fq6Clear

(

Fq6Elem *

result

)

Clear an element's value.

Parameters

[out]

result

element to clear.

Fq6CondSet()

void Fq6CondSet	(	Fq6Elem *	result,
		Fq6Elem const *	true_val,
		Fq6Elem const *	false_val,
		int	truth_val
	)

Conditionally Set an element's value to one of two values.

Parameters

[out]	result	target.
[in]	true_val	value to set if condition is true.
[in]	false_val	value to set if condition is false.
[in]	truth_val	value of condition.

Fq6Cp()

void Fq6Cp	(	Fq6Elem *	result,
		Fq6Elem const *	in
	)

Copy an element's value.

Parameters

[out]	result	copy target.
[in]	in	copy source.

Fq6Eq()

int Fq6Eq	(	Fq6Elem const *	left,
		Fq6Elem const *	right
	)

Test if two elements in Fq6 are equal.

Parameters

[in]	left	The first operand to be tested.
[in]	right	The second operand to be tested.

Returns

A value different from zero (i.e., true) if indeed the values are equal. Zero (i.e., false) otherwise.

Fq6Inv()

void Fq6Inv	(	Fq6Elem *	result,
		Fq6Elem const *	in
	)

Invert an element of Fq6.

Parameters

[out]	result	the inverse of the element.
[in]	in	the element to invert.

Fq6IsZero()

int Fq6IsZero

(

Fq6Elem const *

in

)

Test if an element is zero.

Parameters

[in]

in

the element to test.

Returns

A value different from zero (i.e., true) if indeed the value is zero. Zero (i.e., false) otherwise.

Fq6Mul()

void Fq6Mul	(	Fq6Elem *	result,
		Fq6Elem const *	left,
		Fq6Elem const *	right
	)

Multiply two elements of Fq6.

Parameters

[out]	result	of multiplying left and right.
[in]	left	The first operand to be multiplied.
[in]	right	The second operand to be multiplied.

Fq6MulScalar()

void Fq6MulScalar	(	Fq6Elem *	result,
		Fq6Elem const *	in,
		Fq2Elem const *	scalar
	)

Multiply an element of Fq6 by and element of Fq2.

Parameters

[out]	result	of multiplying left and right.
[in]	in	The first operand to be multiplied.
[in]	scalar	The second operand to be multiplied.

Fq6MulV()

void Fq6MulV	(	Fq6Elem *	result,
		Fq6Elem const *	in
	)

Multiply an element of Fq6 by V.

This function was formerly called as Fq2Const.

Parameters

[out]	result	of multiplying in and V.
[in]	in	The first operand to be multiplied.

Fq6Neg()

void Fq6Neg	(	Fq6Elem *	result,
		Fq6Elem const *	in
	)

Negate an element of Fq6.

Parameters

[out]	result	the negative of the element.
[in]	in	the element to negate.

Fq6Set()

void Fq6Set	(	Fq6Elem *	result,
		uint32_t	in
	)

Set an element's value.

Parameters

[out]	result	target.
[in]	in	value to set.

Fq6Square()

void Fq6Square	(	Fq6Elem *	result,
		Fq6Elem const *	in
	)

Square an element of Fq6.

Parameters

[out]	result	the square of the element.
[in]	in	the element to square.

Fq6Sub()

void Fq6Sub	(	Fq6Elem *	result,
		Fq6Elem const *	left,
		Fq6Elem const *	right
	)

Subtract two elements of Fq6.

Parameters

[out]	result	of subtracting left from right.
[in]	left	The operand to be subtracted from.
[in]	right	The operand to subtract.