LibSWIFFT  1.2.0
Classes | Functions | Variables
LibSwifft Namespace Reference

Classes

struct  SwifftCompact
 An auto-memory-aligned SWIFFT compact-form data structure. More...
 
struct  SwifftInput
 An auto-memory-aligned SWIFFT input data structure. More...
 
struct  SwifftOutput
 An auto-memory-aligned SWIFFT output data structure. More...
 

Functions

SwifftInputCopy (SwifftInput &dst, const SwifftInput &src)
 Copy a SWIFFT input data structure. More...
 
SwifftInputSet (SwifftInput &lhs, BitSequence value)
 Set all 8-bit elements of a SWIFFT input data structure to a value. More...
 
SwifftOutputCopy (SwifftOutput &dst, const SwifftOutput &src)
 Copy a SWIFFT output data structure. More...
 
SwifftOutputSet (SwifftOutput &lhs, const int16_t value)
 Set all 16-bit elements of a SWIFFT output data structure to a value. More...
 
SwifftCompactCopy (SwifftCompact &dst, const SwifftCompact &src)
 Copy a SWIFFT compact-form data structure. More...
 
SwifftCompactSet (SwifftCompact &lhs, BitSequence value)
 Set all 8-bit elements of a SWIFFT compact-form data structure to a value. More...
 
LIBSWIFFT_INLINE bool operator== (const SwifftInput &si1, const SwifftInput &si2)
 Tests for equality of two SWIFFT input data structures. More...
 
LIBSWIFFT_INLINE bool operator!= (const SwifftInput &si1, const SwifftInput &si2)
 Tests for inequality of two SWIFFT input data structures. More...
 
LIBSWIFFT_INLINE bool operator== (const SwifftOutput &so1, const SwifftOutput &so2)
 Tests for equality of two SWIFFT output data structures. More...
 
LIBSWIFFT_INLINE bool operator!= (const SwifftOutput &so1, const SwifftOutput &so2)
 Tests for inequality of two SWIFFT output data structures. More...
 
LIBSWIFFT_INLINE bool operator== (const SwifftCompact &sc1, const SwifftCompact &sc2)
 Tests for equality of two SWIFFT compact-form data structures. More...
 
LIBSWIFFT_INLINE bool operator!= (const SwifftCompact &sc1, const SwifftCompact &sc2)
 Tests for inequality of two SWIFFT compact-form data structures. More...
 
LIBSWIFFT_INLINE SwifftOutputoperator+= (SwifftOutput &lhs, const int16_t value)
 Adds a value to each 16-bit element of a SWIFFT output data structure. More...
 
LIBSWIFFT_INLINE SwifftOutputoperator-= (SwifftOutput &lhs, const int16_t value)
 Subtracts a value from each 16-bit element of a SWIFFT output data structure. More...
 
LIBSWIFFT_INLINE SwifftOutputoperator*= (SwifftOutput &lhs, const int16_t value)
 Multiplies each 16-bit element of a SWIFFT output data structure by a value. More...
 
LIBSWIFFT_INLINE SwifftOutputoperator+= (SwifftOutput &lhs, const SwifftOutput &rhs)
 Adds a second SWIFFT output data structure to a first one, element-wise. More...
 
LIBSWIFFT_INLINE SwifftOutputoperator-= (SwifftOutput &lhs, const SwifftOutput &rhs)
 Subtracts a first SWIFFT output data structure from a second one, element-wise. More...
 
LIBSWIFFT_INLINE SwifftOutputoperator*= (SwifftOutput &lhs, const SwifftOutput &rhs)
 Multiplies a first SWIFFT output data structure by a second one, element-wise. More...
 

Variables

struct SWIFFT_ALIGN SwifftInput
 
struct SWIFFT_ALIGN SwifftOutput
 
struct SWIFFT_ALIGN SwifftCompact
 

Function Documentation

◆ Copy() [1/3]

LIBSWIFFT_INLINE SwifftInput & LibSwifft::Copy ( SwifftInput dst,
const SwifftInput src 
)

Copy a SWIFFT input data structure.

Parameters
[out]dstthe destination to copy to.
[in]srcthe source to copy from.
Returns
the destination.

◆ Copy() [2/3]

LIBSWIFFT_INLINE SwifftOutput & LibSwifft::Copy ( SwifftOutput dst,
const SwifftOutput src 
)

Copy a SWIFFT output data structure.

Parameters
[out]dstthe destination to copy to.
[in]srcthe source to copy from.
Returns
the destination.

◆ Copy() [3/3]

LIBSWIFFT_INLINE SwifftCompact & LibSwifft::Copy ( SwifftCompact dst,
const SwifftCompact src 
)

Copy a SWIFFT compact-form data structure.

Parameters
[out]dstthe destination to copy to.
[in]srcthe source to copy from.
Returns
the destination.

◆ operator!=() [1/3]

LIBSWIFFT_INLINE bool LibSwifft::operator!= ( const SwifftInput si1,
const SwifftInput si2 
)

Tests for inequality of two SWIFFT input data structures.

Parameters
[in]si1the first SWIFFT input.
[in]si2the second SWIFFT input.

◆ operator!=() [2/3]

LIBSWIFFT_INLINE bool LibSwifft::operator!= ( const SwifftOutput so1,
const SwifftOutput so2 
)

Tests for inequality of two SWIFFT output data structures.

Parameters
[in]so1the first SWIFFT output.
[in]so2the second SWIFFT output.

◆ operator!=() [3/3]

LIBSWIFFT_INLINE bool LibSwifft::operator!= ( const SwifftCompact sc1,
const SwifftCompact sc2 
)

Tests for inequality of two SWIFFT compact-form data structures.

Parameters
[in]sc1the first SWIFFT compact-form.
[in]sc2the second SWIFFT compact-form.

◆ operator*=() [1/2]

LIBSWIFFT_INLINE SwifftOutput& LibSwifft::operator*= ( SwifftOutput lhs,
const int16_t  value 
)

Multiplies each 16-bit element of a SWIFFT output data structure by a value.

Parameters
[in,out]lhsthe SWIFFT output.
[in]valuethe value.
Returns
the SWIFFT output.

◆ operator*=() [2/2]

LIBSWIFFT_INLINE SwifftOutput& LibSwifft::operator*= ( SwifftOutput lhs,
const SwifftOutput rhs 
)

Multiplies a first SWIFFT output data structure by a second one, element-wise.

Parameters
[in,out]lhsthe first SWIFFT output.
[in]rhsthe second SWIFFT output.
Returns
the first SWIFFT output.

◆ operator+=() [1/2]

LIBSWIFFT_INLINE SwifftOutput& LibSwifft::operator+= ( SwifftOutput lhs,
const int16_t  value 
)

Adds a value to each 16-bit element of a SWIFFT output data structure.

Parameters
[in,out]lhsthe SWIFFT output.
[in]valuethe value.
Returns
the SWIFFT output.

◆ operator+=() [2/2]

LIBSWIFFT_INLINE SwifftOutput& LibSwifft::operator+= ( SwifftOutput lhs,
const SwifftOutput rhs 
)

Adds a second SWIFFT output data structure to a first one, element-wise.

Parameters
[in,out]lhsthe first SWIFFT output.
[in]rhsthe second SWIFFT output.
Returns
the first SWIFFT output.

◆ operator-=() [1/2]

LIBSWIFFT_INLINE SwifftOutput& LibSwifft::operator-= ( SwifftOutput lhs,
const int16_t  value 
)

Subtracts a value from each 16-bit element of a SWIFFT output data structure.

Parameters
[in,out]lhsthe SWIFFT output.
[in]valuethe value.
Returns
the SWIFFT output.

◆ operator-=() [2/2]

LIBSWIFFT_INLINE SwifftOutput& LibSwifft::operator-= ( SwifftOutput lhs,
const SwifftOutput rhs 
)

Subtracts a first SWIFFT output data structure from a second one, element-wise.

Parameters
[in,out]lhsthe first SWIFFT output.
[in]rhsthe second SWIFFT output.
Returns
the first SWIFFT output.

◆ operator==() [1/3]

LIBSWIFFT_INLINE bool LibSwifft::operator== ( const SwifftInput si1,
const SwifftInput si2 
)

Tests for equality of two SWIFFT input data structures.

Parameters
[in]si1the first SWIFFT input.
[in]si2the second SWIFFT input.

◆ operator==() [2/3]

LIBSWIFFT_INLINE bool LibSwifft::operator== ( const SwifftOutput so1,
const SwifftOutput so2 
)

Tests for equality of two SWIFFT output data structures.

Parameters
[in]so1the first SWIFFT output.
[in]so2the second SWIFFT output.

◆ operator==() [3/3]

LIBSWIFFT_INLINE bool LibSwifft::operator== ( const SwifftCompact sc1,
const SwifftCompact sc2 
)

Tests for equality of two SWIFFT compact-form data structures.

Parameters
[in]sc1the first SWIFFT compact-form.
[in]sc2the second SWIFFT compact-form.

◆ Set() [1/3]

LIBSWIFFT_INLINE SwifftInput & LibSwifft::Set ( SwifftInput lhs,
BitSequence  value 
)

Set all 8-bit elements of a SWIFFT input data structure to a value.

Parameters
[out]lhsthe SWIFFT input to set.
[in]valuethe value to set to.
Returns
the SWIFFT input.

◆ Set() [2/3]

LIBSWIFFT_INLINE SwifftOutput & LibSwifft::Set ( SwifftOutput lhs,
const int16_t  value 
)

Set all 16-bit elements of a SWIFFT output data structure to a value.

Parameters
[out]lhsthe SWIFFT output to set.
[in]valuethe value to set to.
Returns
the SWIFFT output.

◆ Set() [3/3]

LIBSWIFFT_INLINE SwifftCompact & LibSwifft::Set ( SwifftCompact lhs,
BitSequence  value 
)

Set all 8-bit elements of a SWIFFT compact-form data structure to a value.

Parameters
[out]lhsthe SWIFFT compact-form to set.
[in]valuethe value to set to.
Returns
the SWIFFT compact-form.

Variable Documentation

◆ SwifftCompact

◆ SwifftInput

◆ SwifftOutput