An object that mimics the functionality of the Ctxt object, and acts as a convenient entry point for inputting/encoding data which is to be encrypted. More...

#include <Ptxt.h>

Public Types
using	SlotType = typename Scheme::SlotType
	Alias for type to be stored in the slots. More...

Public Member Functions
	Ptxt ()
	Default constructor results in invalid `Ptxt` object which throws if used. More...

	Ptxt (const Context &context)
	Context only constructor, defaults all slots to `0`. More...

	Ptxt (const PubKey &pk)
	Public key only constructor, defaults all slots to `0`. More...

	Ptxt (const Context &context, const SlotType &value)
	Single slot constructor, set all slots to `value`. More...

template<typename U = Scheme, std::enable_if_t< std::is_same< U, BGV >::value > * = nullptr>
	Ptxt (const Context &context, const NTL::ZZX &value)
	BGV plaintext polynomial constructor, set all slots to the `value` polynomial. More...

	Ptxt (const Context &context, const std::vector< SlotType > &data)
	Slot vector constructor. More...

template<typename T >
	Ptxt (const Context &context, const std::vector< T > &data)
	Generic slot vector constructor. More...

	Ptxt (const Ptxt< Scheme > &other)=default
	Default copy constructor. More...

	Ptxt (Ptxt< Scheme > &&other) noexcept=default
	Default move constructor. More...

Ptxt< Scheme > &	operator= (const Ptxt< Scheme > &v)=default
	Copy assignment operator with other `Ptxt`. More...

Ptxt< Scheme > &	operator= (Ptxt< Scheme > &&v) noexcept=default
	Move assignment operator with other `Ptxt`. More...

	~Ptxt ()=default
	Default destructor. More...

bool	isValid () const
	Check if a `Ptxt` is valid. More...

size_t	size () const
	Returns the size (number of slots) of a `Ptxt`. More...

long	lsize () const
	Returns the size (number of slots) of a `Ptxt` as `long`. More...

const Context &	getContext () const
	Returns the `context` used to initialize the `Ptxt` More...

void	setData (const std::vector< SlotType > &data)
	Set the data. More...

void	setData (const SlotType &value)
	Set the data replicating the input on all slots. More...

template<typename T = Scheme, typename std::enable_if_t< std::is_same< T, BGV >::value > * = nullptr>
void	setData (const NTL::ZZX &value)
	Set the `Ptxt` data replicating the input polynomial on all slots. More...

template<typename T = Scheme, typename std::enable_if_t< std::is_same< T, BGV >::value > * = nullptr>
void	decodeSetData (const NTL::ZZX &data)
	Set the `Ptxt` slots using values from decoding `data` to slot representation. More...

void	clear ()
	Sets all slots to `0`. More...

Ptxt< Scheme > &	random ()
	Populate slots with random data. More...

const std::vector< SlotType > &	getSlotRepr () const
	Get the data held in the slots as a `std::vector<SlotType>`. More...

NTL::ZZX	getPolyRepr () const
	Converts the slot data in `this` to its single polynomial representation. More...

void	encode (EncodedPtxt &eptxt, double mag=-1, OptLong prec=OptLong()) const
	Converts the slot data in `this` to a corresponding EncodedPtxt object. mag,prec must be defaulted for BGV (runtime error if not). More...

SlotType &	operator[] (long i)
	Square bracket accessor operator. More...

SlotType	operator[] (long i) const
	`const` square bracket accessor operator. More...

SlotType &	at (long i)
	`at` accessor operator. More...

SlotType	at (long i) const
	`const` `at` accessor operator. More...

bool	operator== (const Ptxt< Scheme > &other) const
	Equals operator between two `Ptxt` objects. More...

bool	operator!= (const Ptxt< Scheme > &other) const
	Not equals operator between two `Ptxt` objects. More...

Ptxt< Scheme >	operator* (const Ptxt< Scheme > &rhs) const
	Infix multiplication operator. More...

Ptxt< Scheme >	operator+ (const Ptxt< Scheme > &rhs) const
	Infix addition operator. More...

Ptxt< Scheme >	operator- (const Ptxt< Scheme > &rhs) const
	Infix subtraction operator. More...

Ptxt< Scheme > &	operator*= (const Ptxt< Scheme > &otherPtxt)
	Times equals operator with another `Ptxt`. More...

Ptxt< Scheme > &	operator*= (const SlotType &scalar)
	Times equals operator with a single `SlotType`. More...

template<typename Scalar >
Ptxt< Scheme > &	operator*= (const Scalar &scalar)
	Times equals operator with a scalar. More...

Ptxt< Scheme > &	operator+= (const Ptxt< Scheme > &otherPtxt)
	Plus equals operator with another `Ptxt`. More...

Ptxt< Scheme > &	operator+= (const SlotType &scalar)
	Plus equals operator with a single `SlotType`. More...

template<typename Scalar >
Ptxt< Scheme > &	operator+= (const Scalar &scalar)
	Plus equals operator with a scalar. More...

Ptxt< Scheme > &	operator-= (const Ptxt< Scheme > &otherPtxt)
	Minus equals operator with another `Ptxt`. More...

Ptxt< Scheme > &	operator-= (const SlotType &scalar)
	Minus equals operator with a single `SlotType`. More...

template<typename Scalar >
Ptxt< Scheme > &	operator-= (const Scalar &scalar)
	Minus equals operator with a scalar. More...

Ptxt< Scheme > &	negate ()
	Negate a `Ptxt`. More...

template<typename T = Scheme, typename Scalar , typename std::enable_if_t< std::is_same< T, BGV >::value > * = nullptr>
Ptxt< Scheme > &	addConstant (const Scalar &scalar)
	Add a constant to a BGV `Ptxt`. More...

template<typename T = Scheme, typename Scalar , typename std::enable_if_t< std::is_same< T, CKKS >::value > * = nullptr>
Ptxt< Scheme > &	addConstantCKKS (const Scalar &scalar)
	Add a constant to a CKKS `Ptxt`. More...

Ptxt< Scheme > &	multiplyBy (const Ptxt< Scheme > &otherPtxt)
	Multiplication function between two `Ptxt` objects. More...

Ptxt< Scheme > &	multiplyBy2 (const Ptxt &otherPtxt1, const Ptxt &otherPtxt2)
	Multiplication function between three `Ptxt` objects. More...

Ptxt< Scheme > &	square ()
	Square operation on a `Ptxt`. More...

Ptxt< Scheme > &	cube ()
	Cube operation on a `Ptxt`. More...

Ptxt< Scheme > &	power (long e)
	Power operation to raise a `Ptxt` to an arbitrary non-negative power. More...

Ptxt< Scheme > &	rotate (long amount)
	Rotate slots right by specified amount (slot `i` goes to slot `i+1 mod size`). More...

Ptxt< Scheme > &	rotate1D (long dim, long amount)
	Rotate slots right by specified amount along a specific dimension. More...

Ptxt< Scheme > &	shift (long amount)
	Shifts slots right by specified amount with `0` fill (slot `i` goes to slot `i+1 mod size`). More...

Ptxt< Scheme > &	shift1D (long dim, long amount)
	Shift slots right in one dimension of the hypercube structure with `0` fill. More...

Ptxt< Scheme > &	automorph (long k)
	Apply the automorphism a(X) -> a(X^k) mod Phi_m(X). More...

template<typename T = Scheme, std::enable_if_t< std::is_same< T, BGV >::value > * = nullptr>
Ptxt< Scheme > &	frobeniusAutomorph (long j)
	Apply the frobenius automorphism a(X) -> a(X^(p^j)) mod Phi_m(X). More...

Ptxt< Scheme > &	replicate (long pos)
	Replicate single slot across all slots. More...

std::vector< Ptxt< Scheme > >	replicateAll () const
	Generate a vector of plaintexts with each slot replicated in each plaintext. More...

template<typename T = Scheme, std::enable_if_t< std::is_same< T, CKKS >::value > * = nullptr>
Ptxt< Scheme > &	complexConj ()
	Apply complex conjugate of complex numbers in slots of a `CKKS` `Ptxt` object. More...

template<typename T = Scheme, std::enable_if_t< std::is_same< T, CKKS >::value > * = nullptr>
Ptxt< Scheme >	real () const
	Extract the real part of a CKKS plaintext. More...

template<typename T = Scheme, std::enable_if_t< std::is_same< T, CKKS >::value > * = nullptr>
Ptxt< Scheme >	imag () const
	Extract the imaginary part of a CKKS plaintext. More...

Ptxt< Scheme > &	runningSums ()
	Compute the running sum (each slot is the sum of the previous slots). More...

Ptxt< Scheme > &	totalSums ()
	Compute the total sum (each slot contains the total sum of every slot). More...

Ptxt< Scheme > &	incrementalProduct ()
	Compute the incremental product (each slot is the product of the previous slots). More...

Ptxt< Scheme > &	totalProduct ()
	Compute the total product (each slot contains the total product of every slot). More...

Ptxt< Scheme > &	mapTo01 ()
	Map all non-zero slots to `1`, keeping zero slots as zero. More...

void	writeToJSON (std::ostream &os) const
	Function to serialize `this` `Ptxt<Scheme>`. More...

JsonWrapper	writeToJSON () const
	Function to serialize `this` `Ptxt<Scheme>`. More...

void	readJSON (std::istream &is)
	In-place function to deserialize a `Ptxt<Scheme>` from a JSON stream. More...

void	readJSON (const JsonWrapper &jw)
	In-place function to deserialize a `Ptxt<Scheme>` from a `JsonWrapper` object. More...

Ptxt< Scheme > &	cleanUp ()
	To be inline with the `Ctxt` interface. However for `Ptxt` this means do nothing. More...

PolyMod	convertToSlot (const Context &context, long slot)

std::complex< double >	convertToSlot (const Context &, long slot)

void	setData (const NTL::ZZX &value)

	Ptxt (const Context &context, const NTL::ZZX &value)

void	decodeSetData (const NTL::ZZX &data)

NTL::ZZX	getPolyRepr () const
	BGV specialisation of the `getPolyRepr` function. More...

void	encode (EncodedPtxt &eptxt, double mag, OptLong prec) const

void	encode (EncodedPtxt &eptxt, double mag, OptLong prec) const
	CKKS specialisation of the `getPolyRepr` function. More...

Ptxt< BGV > &	automorph (long k)

Ptxt< CKKS > &	automorph (long k)

Ptxt< BGV > &	frobeniusAutomorph (long j)

Ptxt< CKKS > &	complexConj ()

Ptxt< CKKS >	real () const

Ptxt< CKKS >	imag () const

Static Public Member Functions
static Ptxt< Scheme >	readFromJSON (std::istream &is, const Context &context)
	Function to deserialize and return a `Ptxt<Scheme>` from a JSON stream. More...

static Ptxt< Scheme >	readFromJSON (const JsonWrapper &jw, const Context &context)
	Function to deserialize and return a `Ptxt<Scheme>` from a `JsonWrapper` object. More...

static SlotType	convertToSlot (const Context &context, long slot)
	Conversion function from `long` to `SlotType`. More...

Static Public Attributes
static constexpr std::string_view	typeName = "Ptxt"
	Class label to be added to JSON serialization as object type information. More...

Friends
std::istream &	operator>> (std::istream &is, Ptxt &ptxt)
	Input shift operator. Uses the `deserialize` function internally. More...

std::ostream &	operator (std::ostream &os, const Ptxt &ptxt)

Detailed Description

template<typename Scheme>
class helib::Ptxt< Scheme >

An object that mimics the functionality of the Ctxt object, and acts as a convenient entry point for inputting/encoding data which is to be encrypted.

Ptxt is templated on Scheme, which may be CKKS or BGV.

In the BGV case, Ptxt can be considered to be an element of $\mathbb{Z}_p[x]/\Phi(m)$ viewed as a vector of slots with values each in $\mathbb{Z}_p[x]/G$ where G is one of the irreducible factors of $\Phi(m)$ , and all operations are performed entry-wise.

General usage:

helib::Ptxt<BGV> p1(bgv_context, data);
helib::Ptxt<BGV> p2(bgv_context, data);
p1 += p2;
std::cout << p1 << std::endl;

Internally, Ptxt objects store their data as a std::vector<helib::PolyMod>, where PolyMod is a convenience type representing an element of the above ring, $\mathbb{Z}_p[x]/G$ . The PolyMod type can be easily converted via static_cast to more convenient types such as long and NTL::ZZX.

In the CKKS case, the slot type is std::complex<double>, and has sensible operator overloads supporting operations with other Ptxt<CKKS>, Ctxt, and std::complex<double> objects, as well as performing all operations slot-wise.

A large number of operator overloads are defined so that Ptxt objects should easily inter-operate, as well as providing interoperability with other logically compatible types e.g. long and NTL::ZZX in the BGV case, std::complex<double> in the CKKS case, and helib::Ctxt in both cases.

Member Typedef Documentation

◆ SlotType

template<typename Scheme >

using helib::Ptxt< Scheme >::SlotType = typename Scheme::SlotType

Alias for type to be stored in the slots.

std::complex<double> for CKKS, helib::PolyMod for BGV.

Constructor & Destructor Documentation

◆ Ptxt() [1/10]

template<typename Scheme >

helib::Ptxt< Scheme >::Ptxt

Default constructor results in invalid Ptxt object which throws if used.

◆ Ptxt() [2/10]

template<typename Scheme >

helib::Ptxt< Scheme >::Ptxt ( const Context & context )

explicit

Context only constructor, defaults all slots to 0.

Parameters

context Context to use.

◆ Ptxt() [3/10]

template<typename Scheme >

helib::Ptxt< Scheme >::Ptxt ( const PubKey & pk )

inlineexplicit

Public key only constructor, defaults all slots to 0.

Parameters

pk	The public key used as a proxy to the context.

Note: This is needed to match calls to Ctxt.

◆ Ptxt() [4/10]

template<typename Scheme >

helib::Ptxt< Scheme >::Ptxt	(	const Context &	context,
		const SlotType &	value
	)

Single slot constructor, set all slots to value.

Parameters

context	`Context` to use.
value	Value to set all slots to.

◆ Ptxt() [5/10]

template<typename Scheme >

template<typename U = Scheme, std::enable_if_t< std::is_same< U, BGV >::value > * = nullptr>

helib::Ptxt< Scheme >::Ptxt	(	const Context &	context,
		const NTL::ZZX &	value
	)

BGV plaintext polynomial constructor, set all slots to the value polynomial.

Parameters

context	`Context` to use.
data	Polynomial to be converted into slot representation.

Note: Only exists for BGV.

◆ Ptxt() [6/10]

template<typename Scheme >

helib::Ptxt< Scheme >::Ptxt	(	const Context &	context,
		const std::vector< SlotType > &	data
	)

Slot vector constructor.

Parameters

context	`Context` to use.
data	Data to populate the slots.

◆ Ptxt() [7/10]

template<typename Scheme >

template<typename T >

helib::Ptxt< Scheme >::Ptxt	(	const Context &	context,
		const std::vector< T > &	data
	)

inline

Generic slot vector constructor.

Parameters

context	`Context` to use.
data	Data to populate the slots, must be convertible to `SlotType`.

◆ Ptxt() [8/10]

template<typename Scheme >

helib::Ptxt< Scheme >::Ptxt ( const Ptxt< Scheme > & other )

default

Default copy constructor.

Parameters

other Ptxt object to copy.

◆ Ptxt() [9/10]

template<typename Scheme >

helib::Ptxt< Scheme >::Ptxt ( Ptxt< Scheme > && other )

defaultnoexcept

Default move constructor.

Parameters

other Ptxt to copy.

◆ ~Ptxt()

template<typename Scheme >

helib::Ptxt< Scheme >::~Ptxt ( )

default

Default destructor.

◆ Ptxt() [10/10]

helib::Ptxt< BGV >::Ptxt	(	const Context &	context,
		const NTL::ZZX &	value
	)

Member Function Documentation

◆ addConstant()

template<typename Scheme >

template<typename T = Scheme, typename Scalar , typename std::enable_if_t< std::is_same< T, BGV >::value > * = nullptr>

Ptxt<Scheme>& helib::Ptxt< Scheme >::addConstant ( const Scalar & scalar )

inline

Add a constant to a BGV Ptxt.

Parameters

scalar Element to be added across all slots.

Returns: Reference to *this post scalar addition.

◆ addConstantCKKS()

template<typename Scheme >

template<typename T = Scheme, typename Scalar , typename std::enable_if_t< std::is_same< T, CKKS >::value > * = nullptr>

Ptxt<Scheme>& helib::Ptxt< Scheme >::addConstantCKKS ( const Scalar & scalar )

inline

Add a constant to a CKKS Ptxt.

Parameters

scalar Element to be added across all slots.

Returns: Reference to *this post scalar addition.

◆ at() [1/2]

template<typename Scheme >

Ptxt< Scheme >::SlotType & helib::Ptxt< Scheme >::at ( long i )

at accessor operator.

Parameters

i	Index of the desired `Ptxt` slot.

Returns: Reference to the data held at slot i.

Note: throws if i is out of range.

◆ at() [2/2]

template<typename Scheme >

Ptxt< Scheme >::SlotType helib::Ptxt< Scheme >::at ( long i ) const

const at accessor operator.

Parameters

i	Index of the desired `Ptxt` slot.

Returns: Copy of the data held at slot i.

Note: throws if i is out of range.

◆ automorph() [1/3]

template<typename Scheme >

Ptxt<Scheme>& helib::Ptxt< Scheme >::automorph ( long k )

Apply the automorphism a(X) -> a(X^k) mod Phi_m(X).

Parameters

k	Exponent of the automorphism to apply.

Returns: Reference to *this post automorphism application.

Note: k must be an element of Zm*

◆ automorph() [2/3]

Ptxt< BGV > & helib::Ptxt< BGV >::automorph ( long k )

◆ automorph() [3/3]

Ptxt< CKKS > & helib::Ptxt< CKKS >::automorph ( long k )

◆ cleanUp()

template<typename Scheme >

Ptxt<Scheme>& helib::Ptxt< Scheme >::cleanUp ( )

inline

To be inline with the Ctxt interface. However for Ptxt this means do nothing.

Returns: Reference to *this.

◆ clear()

template<typename Scheme >

void helib::Ptxt< Scheme >::clear

Sets all slots to 0.

◆ complexConj() [1/2]

template<typename Scheme >

template<typename T = Scheme, std::enable_if_t< std::is_same< T, CKKS >::value > * = nullptr>

Ptxt<Scheme>& helib::Ptxt< Scheme >::complexConj ( )

Apply complex conjugate of complex numbers in slots of a CKKS Ptxt object.

Returns: Reference to *this post complex conjugation.

Note: Only valid for the CKKS scheme.

◆ complexConj() [2/2]

Ptxt< CKKS > & helib::Ptxt< CKKS >::complexConj ( )

◆ convertToSlot() [1/3]

std::complex< double > helib::Ptxt< CKKS >::convertToSlot	(	const Context &	,
		long	slot
	)

◆ convertToSlot() [2/3]

template<typename Scheme >

static SlotType helib::Ptxt< Scheme >::convertToSlot	(	const Context &	context,
		long	slot
	)

static

Conversion function from long to SlotType.

Parameters

context	Context which may be needed to extract algebraic info.
slot	Datum to be converted to a `SlotType`.

Returns: Converted slot.

◆ convertToSlot() [3/3]

PolyMod helib::Ptxt< BGV >::convertToSlot	(	const Context &	context,
		long	slot
	)

◆ cube()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::cube

Cube operation on a Ptxt.

Returns: Reference to *this post cube operation.

◆ decodeSetData() [1/2]

template<typename Scheme >

template<typename T = Scheme, typename std::enable_if_t< std::is_same< T, BGV >::value > * = nullptr>

void helib::Ptxt< Scheme >::decodeSetData ( const NTL::ZZX & data )

Set the Ptxt slots using values from decoding data to slot representation.

Parameters

data	Polynomial to be decoded and converted into slot data.

Note: Only works in the BGV case.

◆ decodeSetData() [2/2]

void helib::Ptxt< BGV >::decodeSetData ( const NTL::ZZX & data )

◆ encode() [1/3]

void helib::Ptxt< BGV >::encode	(	EncodedPtxt< Scheme > &	eptxt,
		double	mag,
		OptLong	prec
	)		const

◆ encode() [2/3]

void helib::Ptxt< CKKS >::encode	(	EncodedPtxt< Scheme > &	eptxt,
		double	mag,
		OptLong	prec
	)		const

CKKS specialisation of the getPolyRepr function.

Returns: Single encoded polynomial.

Note: Only enabled for the CKKS scheme.

◆ encode() [3/3]

template<typename Scheme >

void helib::Ptxt< Scheme >::encode	(	EncodedPtxt< Scheme > &	eptxt,
		double	mag = `-1`,
		OptLong	prec = `OptLong()`
	)		const

Converts the slot data in this to a corresponding EncodedPtxt object. mag,prec must be defaulted for BGV (runtime error if not).

◆ frobeniusAutomorph() [1/2]

template<typename Scheme >

template<typename T = Scheme, std::enable_if_t< std::is_same< T, BGV >::value > * = nullptr>

Ptxt<Scheme>& helib::Ptxt< Scheme >::frobeniusAutomorph ( long j )

Apply the frobenius automorphism a(X) -> a(X^(p^j)) mod Phi_m(X).

Parameters

j	Exponent of the automorphism to apply.

Returns: Reference to *this post frobenius automorphism application.

Note: Only valid for the BGV scheme.

◆ frobeniusAutomorph() [2/2]

Ptxt< BGV > & helib::Ptxt< BGV >::frobeniusAutomorph ( long j )

◆ getContext()

template<typename Scheme >

const Context& helib::Ptxt< Scheme >::getContext ( ) const

inline

Returns the context used to initialize the Ptxt

Returns: The context.

◆ getPolyRepr() [1/2]

template<typename Scheme >

NTL::ZZX helib::Ptxt< Scheme >::getPolyRepr ( ) const

Converts the slot data in this to its single polynomial representation.

Returns: Single encoded polynomial.

Note: NTL::ZZX representation loses some precision in the CKKS case.

◆ getPolyRepr() [2/2]

NTL::ZZX helib::Ptxt< BGV >::getPolyRepr ( ) const

BGV specialisation of the getPolyRepr function.

Returns: Single encoded polynomial.

Note: Only enabled for the BGV scheme.

◆ getSlotRepr()

template<typename Scheme >

const std::vector< typename Ptxt< Scheme >::SlotType > & helib::Ptxt< Scheme >::getSlotRepr

Get the data held in the slots as a std::vector<SlotType>.

Returns: Constant reference to the slot vector.

◆ imag() [1/2]

template<typename Scheme >

template<typename T = Scheme, std::enable_if_t< std::is_same< T, CKKS >::value > * = nullptr>

Ptxt<Scheme> helib::Ptxt< Scheme >::imag ( ) const

Extract the imaginary part of a CKKS plaintext.

Returns: New plaintext containing the imaginary part of each slot.

Note: Only valid for the CKKS scheme.

◆ imag() [2/2]

Ptxt< CKKS > helib::Ptxt< CKKS >::imag ( ) const

◆ incrementalProduct()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::incrementalProduct

Compute the incremental product (each slot is the product of the previous slots).

Returns: Reference to *this post multiplication.

◆ isValid()

template<typename Scheme >

bool helib::Ptxt< Scheme >::isValid

Check if a Ptxt is valid.

Returns: true if valid, false otherwise.

◆ lsize()

template<typename Scheme >

long helib::Ptxt< Scheme >::lsize

Returns the size (number of slots) of a Ptxt as long.

Returns: Number of slots of the Ptxt.

◆ mapTo01()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::mapTo01

Map all non-zero slots to 1, keeping zero slots as zero.

Returns: Reference to *this post mapping.

◆ multiplyBy()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::multiplyBy ( const Ptxt< Scheme > & otherPtxt )

Multiplication function between two Ptxt objects.

Parameters

otherPtxt Right hand side of multiplication.

Returns: Reference to *this post multiplication.

Note: This function is equivalent to operator *=.

◆ multiplyBy2()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::multiplyBy2	(	const Ptxt< Scheme > &	otherPtxt1,
		const Ptxt< Scheme > &	otherPtxt2
	)

Multiplication function between three Ptxt objects.

Parameters

otherPtxt1	First `Ptxt` to multiply with.
otherPtxt2	Second `Ptxt` to multiply with.

Returns: Reference to *this post multiplication.

◆ negate()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::negate

Negate a Ptxt.

Returns: Reference to *this post negation.

◆ operator!=()

template<typename Scheme >

bool helib::Ptxt< Scheme >::operator!= ( const Ptxt< Scheme > & other ) const

Not equals operator between two Ptxt objects.

Parameters

other Ptxt to compare to.

Returns: true if differ, false otherwise.

◆ operator*()

template<typename Scheme >

Ptxt< Scheme > helib::Ptxt< Scheme >::operator* ( const Ptxt< Scheme > & rhs ) const

Infix multiplication operator.

Parameters

rhs	Right hand side of multiplication.

Returns: Product of the two Ptxt objects.

◆ operator*=() [1/3]

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::operator*= ( const Ptxt< Scheme > & otherPtxt )

Times equals operator with another Ptxt.

Parameters

otherPtxt Right hand side of multiplication.

Returns: Reference to *this post multiplication.

◆ operator*=() [2/3]

template<typename Scheme >

template<typename Scalar >

Ptxt<Scheme>& helib::Ptxt< Scheme >::operator*= ( const Scalar & scalar )

inline

Times equals operator with a scalar.

Parameters

scalar Element to be added across all slots.

Returns: Reference to *this post scalar multiplication.

◆ operator*=() [3/3]

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::operator*= ( const SlotType & scalar )

Times equals operator with a single SlotType.

Parameters

scalar Element to be multiplied across all slots.

Returns: Reference to *this post multiplication.

◆ operator+()

template<typename Scheme >

Ptxt< Scheme > helib::Ptxt< Scheme >::operator+ ( const Ptxt< Scheme > & rhs ) const

Infix addition operator.

Parameters

rhs	Right hand side of addition.

Returns: Sum of the two Ptxt objects.

◆ operator+=() [1/3]

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::operator+= ( const Ptxt< Scheme > & otherPtxt )

Plus equals operator with another Ptxt.

Parameters

otherPtxt Right hand side of addition.

Returns: Reference to *this post addition.

◆ operator+=() [2/3]

template<typename Scheme >

template<typename Scalar >

Ptxt<Scheme>& helib::Ptxt< Scheme >::operator+= ( const Scalar & scalar )

inline

Plus equals operator with a scalar.

Parameters

scalar Element to be added across all slots.

Returns: Reference to *this post scalar addition.

◆ operator+=() [3/3]

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::operator+= ( const SlotType & scalar )

Plus equals operator with a single SlotType.

Parameters

scalar Element to be added across all slots.

Returns: Reference to *this post addition.

◆ operator-()

template<typename Scheme >

Ptxt< Scheme > helib::Ptxt< Scheme >::operator- ( const Ptxt< Scheme > & rhs ) const

Infix subtraction operator.

Parameters

rhs	Right hand side of subtraction.

Returns: Difference of the two Ptxt objects.

◆ operator-=() [1/3]

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::operator-= ( const Ptxt< Scheme > & otherPtxt )

Minus equals operator with another Ptxt.

Parameters

otherPtxt Right hand side of subtraction.

Returns: Reference to *this post subtraction.

◆ operator-=() [2/3]

template<typename Scheme >

template<typename Scalar >

Ptxt<Scheme>& helib::Ptxt< Scheme >::operator-= ( const Scalar & scalar )

inline

Minus equals operator with a scalar.

Parameters

scalar Element to be subtracted across all slots.

Returns: Reference to *this post scalar subtraction.

◆ operator-=() [3/3]

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::operator-= ( const SlotType & scalar )

Minus equals operator with a single SlotType.

Parameters

scalar Element to be subtracted across all slots.

Returns: Reference to *this post subtraction.

◆ operator=() [1/2]

template<typename Scheme >

Ptxt<Scheme>& helib::Ptxt< Scheme >::operator= ( const Ptxt< Scheme > & v )

default

Copy assignment operator with other Ptxt.

Parameters

other Ptxt to copy.

◆ operator=() [2/2]

template<typename Scheme >

Ptxt<Scheme>& helib::Ptxt< Scheme >::operator= ( Ptxt< Scheme > && v )

defaultnoexcept

Move assignment operator with other Ptxt.

Parameters

other Ptxt to copy.

◆ operator==()

template<typename Scheme >

bool helib::Ptxt< Scheme >::operator== ( const Ptxt< Scheme > & other ) const

Equals operator between two Ptxt objects.

Parameters

other Ptxt to compare to.

Returns: true if identical, false otherwise.

◆ operator[]() [1/2]

template<typename Scheme >

Ptxt< Scheme >::SlotType & helib::Ptxt< Scheme >::operator[] ( long i )

Square bracket accessor operator.

Parameters

i	Index of the desired `Ptxt` slot.

Returns: Reference to the data held at slot i.

◆ operator[]() [2/2]

template<typename Scheme >

Ptxt< Scheme >::SlotType helib::Ptxt< Scheme >::operator[] ( long i ) const

const square bracket accessor operator.

Parameters

i	Index of the desired `Ptxt` slot.

Returns: Copy of the data held at slot i.

◆ power()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::power ( long e )

Power operation to raise a Ptxt to an arbitrary non-negative power.

Parameters

e	Exponent to raise the `Ptxt` by.

Returns: Reference to *this post raising to the power e.

◆ random()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::random

Populate slots with random data.

Returns: Reference to *this post population.

◆ readFromJSON() [1/2]

template<typename Scheme >

Ptxt< Scheme > helib::Ptxt< Scheme >::readFromJSON	(	const JsonWrapper &	jw,
		const Context &	context
	)

static

Function to deserialize and return a Ptxt<Scheme> from a JsonWrapper object.

Parameters

jw	`JsonWrapper` containing the serialized object.

Exceptions

IOError

if the JsonWrapper object does not contains a valid serialization of a Ptxt<Scheme>.

Ptxt<BGV> my_ptxt = Ptxt<BGV>::readFromJSON(..., context);

helib::Ptxt::readFromJSON

static Ptxt< Scheme > readFromJSON(std::istream &is, const Context &context)

Function to deserialize and return a Ptxt<Scheme> from a JSON stream.

Definition: Ptxt.cpp:979

The JsonWrapper must contain a valid Ptxt<scheme> serialization.
Each element of the content list will be deserialized as a slot of the type determined by the scheme.
If the number of tokens in the slot list is less than the number of slots, the remaining slots will be padded by 0.
For example a slot list '['slot0', 'slot1', 'slot2']' will be deserialized as a plaintext ptxt where ptxt[0]=slot0, ptxt[1]=slot1, ptxt[2]=slot2 and ptxt[i]=0 for i>2.

◆ readFromJSON() [2/2]

template<typename Scheme >

Ptxt< Scheme > helib::Ptxt< Scheme >::readFromJSON	(	std::istream &	is,
		const Context &	context
	)

static

Function to deserialize and return a Ptxt<Scheme> from a JSON stream.

Parameters

is	Input `std::istream`.

Exceptions

IOError

if the stream is badly formatted (i.e. it does not contain a valid JSON).

Ptxt<BGV> my_ptxt = Ptxt<BGV>::readFromJSON(std::cin, context);

The input stream has to contain a valid typed JSON value.
Each element of the content list will be deserialized as a slot of the type determined by the scheme.
If the number of tokens in the slot list is less than the number of slots, the remaining slots will be padded by 0.
For example a slot list '['slot0', 'slot1', 'slot2']' will be deserialized as a plaintext ptxt where ptxt[0]=slot0, ptxt[1]=slot1, ptxt[2]=slot2 and ptxt[i]=0 for i>2.

◆ readJSON() [1/2]

template<typename Scheme >

void helib::Ptxt< Scheme >::readJSON ( const JsonWrapper & jw )

In-place function to deserialize a Ptxt<Scheme> from a JsonWrapper object.

Parameters

jw	`JsonWrapper` containing the serialized object.

Exceptions

IOError if the JsonWrapper object does not contains a valid serialization of a Ptxt<Scheme>.

Note: this must be constructed with an appropriate context BEFORE calling this function. For example,
Ptxt my_ptxt(context);

my_ptxt.readJSON(...);

helib::Ptxt::Ptxt
Ptxt()
Default constructor results in invalid Ptxt object which throws if used.
Definition: Ptxt.cpp:35

The JsonWrapper must contain a valid Ptxt<scheme> serialization.
Each element of the content list will be deserialized as a slot of the type determined by the scheme.
If the number of tokens in the slot list is less than the number of slots, the remaining slots will be padded by 0.
For example a slot list '['slot0', 'slot1', 'slot2']' will be deserialized as a plaintext ptxt where ptxt[0]=slot0, ptxt[1]=slot1, ptxt[2]=slot2 and ptxt[i]=0 for i>2.

◆ readJSON() [2/2]

template<typename Scheme >

void helib::Ptxt< Scheme >::readJSON ( std::istream & is )

In-place function to deserialize a Ptxt<Scheme> from a JSON stream.

Parameters

is	Input `std::istream`.

Exceptions

IOError if the stream is badly formatted (i.e. it does not contain a valid JSON).

Note: this must be constructed with an appropriate context BEFORE calling this function. For example,
Ptxt my_ptxt(context);

my_ptxt.readJSON(std::cin);

The input stream has to contain a valid typed JSON value.
Each element of the content list will be deserialized as a slot of the type determined by the scheme.
If the number of tokens in the slot list is less than the number of slots, the remaining slots will be padded by 0.
For example a slot list '['slot0', 'slot1', 'slot2']' will be deserialized as a plaintext ptxt where ptxt[0]=slot0, ptxt[1]=slot1, ptxt[2]=slot2 and ptxt[i]=0 for i>2.

◆ real() [1/2]

template<typename Scheme >

template<typename T = Scheme, std::enable_if_t< std::is_same< T, CKKS >::value > * = nullptr>

Ptxt<Scheme> helib::Ptxt< Scheme >::real ( ) const

Extract the real part of a CKKS plaintext.

Returns: New plaintext containing the real part of each slot.

Note: Only valid for the CKKS scheme.

◆ real() [2/2]

Ptxt< CKKS > helib::Ptxt< CKKS >::real ( ) const

◆ replicate()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::replicate ( long pos )

Replicate single slot across all slots.

Parameters

pos	Position of the slot to replicate.

Returns: Reference to *this post replication.

◆ replicateAll()

template<typename Scheme >

std::vector< Ptxt< Scheme > > helib::Ptxt< Scheme >::replicateAll

Generate a vector of plaintexts with each slot replicated in each plaintext.

Returns: Vector of replicated plaintext slots. The order of the return vector agrees with the order of the slots. i.e. the i-th plaintext in the return value is a replication of *this[i].

◆ rotate()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::rotate ( long amount )

Rotate slots right by specified amount (slot i goes to slot i+1 mod size).

Parameters

amount Number of slots to rotate by.

Returns: Reference to *this post rotation.

◆ rotate1D()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::rotate1D	(	long	dim,
		long	amount
	)

Rotate slots right by specified amount along a specific dimension.

Parameters

dim	Dimension in which to rotate.
amount	Number of slots to rotate by.

Returns: Reference to *this post rotation.

◆ runningSums()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::runningSums

Compute the running sum (each slot is the sum of the previous slots).

Returns: Reference to *this post summation.

◆ setData() [1/4]

template<typename Scheme >

template<typename T = Scheme, typename std::enable_if_t< std::is_same< T, BGV >::value > * = nullptr>

void helib::Ptxt< Scheme >::setData ( const NTL::ZZX & value )

Set the Ptxt data replicating the input polynomial on all slots.

Parameters

data	Polynomial to be replicate into slots.

Note: Only works in the BGV case.

◆ setData() [2/4]

void helib::Ptxt< BGV >::setData ( const NTL::ZZX & value )

◆ setData() [3/4]

template<typename Scheme >

void helib::Ptxt< Scheme >::setData ( const SlotType & value )

Set the data replicating the input on all slots.

Parameters

value value to set all slots to.

◆ setData() [4/4]

template<typename Scheme >

void helib::Ptxt< Scheme >::setData ( const std::vector< SlotType > & data )

Set the data.

Parameters

data	Vector of `SlotType` to populate the slots.

◆ shift()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::shift ( long amount )

Shifts slots right by specified amount with 0 fill (slot i goes to slot i+1 mod size).

Parameters

amount Number of slots to shift by.

Returns: Reference to *this post shift.

◆ shift1D()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::shift1D	(	long	dim,
		long	amount
	)

Shift slots right in one dimension of the hypercube structure with 0 fill.

Parameters

dim	Dimension in which to shift.
amount	Amount by which to shift.

Returns: Reference to *this post shift.

◆ size()

template<typename Scheme >

size_t helib::Ptxt< Scheme >::size

Returns the size (number of slots) of a Ptxt.

Returns: Number of slots of the Ptxt.

◆ square()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::square

Square operation on a Ptxt.

Returns: Reference to *this post squaring.

◆ totalProduct()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::totalProduct

Compute the total product (each slot contains the total product of every slot).

Returns: Reference to *this post multiplication.

◆ totalSums()

template<typename Scheme >

Ptxt< Scheme > & helib::Ptxt< Scheme >::totalSums

Compute the total sum (each slot contains the total sum of every slot).

Returns: Reference to *this post summation.

◆ writeToJSON() [1/2]

template<typename Scheme >

JsonWrapper helib::Ptxt< Scheme >::writeToJSON

Function to serialize this Ptxt<Scheme>.

Returns: The JsonWrapper containing the serialization.

Note: Ptxt context is not serialized, see note of readJSON.

The output JsonWrapper will be a JSON where the Ptxt content will be serialized in the slots field.
Each slot of ptxt will be serialized in an element of such list by the JSON serializer function determined by the scheme.
For example if we have a plaintext ptxt such that ptxt[0]=slot0, ptxt[1]=slot1, ptxt[2]=slot2, and ptxt[i]=0 for i>2, it will be serialized as '['slot0', 'slot1', 'slot2', 0, 0, ...]'.

◆ writeToJSON() [2/2]

template<typename Scheme >

void helib::Ptxt< Scheme >::writeToJSON ( std::ostream & os ) const

Function to serialize this Ptxt<Scheme>.

Parameters

os	Output `std::ostream`.

Note: Ptxt context is not serialized, see note of readJSON.

The output stream will be a JSON where the Ptxt content will be serialized in the slots field.
Each slot of ptxt will be serialized in an element of such list by the JSON serializer function determined by the scheme.
For example if we have a plaintext ptxt such that ptxt[0]=slot0, ptxt[1]=slot1, ptxt[2]=slot2, and ptxt[i]=0 for i>2, it will be serialized as '['slot0', 'slot1', 'slot2', 0, 0 ...]'.

Friends And Related Function Documentation

◆ operator

template<typename Scheme >

std::ostream& operator	(	std::ostream &	os,
		const Ptxt< Scheme > &	ptxt
	)

friend

◆ operator>>

template<typename Scheme >

std::istream& operator>>	(	std::istream &	is,
		Ptxt< Scheme > &	ptxt
	)

friend

Input shift operator. Uses the deserialize function internally.

Parameters

is	Input `std::istream`.
ptxt	Destination `Ptxt` object.

Returns: Input std::istream post reading.

Note: ptxt must be constructed with an appropriate context BEFORE calling this function. For example,
Ptxt my_ptxt(context);

std::cin >> my_ptxt;

The input stream has to be formatted as a comma-separated list surrounded by '[' and ']'.
Each element of the list will be deserialized as a slot of the type determined by the scheme.
If the number of tokens in the list is less than the number of slots, the remaining slots will be padded by 0.
For example '['slot0', 'slot1', 'slot2']' will be deserialized as a plaintext ptxt where ptxt[0]=slot0, ptxt[1]=slot1, ptxt[2]=slot2 and ptxt[i]=0 for i>2.

Member Data Documentation

◆ typeName

template<typename Scheme >

constexpr std::string_view helib::Ptxt< Scheme >::typeName = "Ptxt"

staticconstexpr

Class label to be added to JSON serialization as object type information.

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

template<typename Scheme> class helib::Ptxt< Scheme >

Member Typedef Documentation

◆ SlotType

Constructor & Destructor Documentation

◆ Ptxt() [1/10]

◆ Ptxt() [2/10]

◆ Ptxt() [3/10]

◆ Ptxt() [4/10]

◆ Ptxt() [5/10]

◆ Ptxt() [6/10]

◆ Ptxt() [7/10]

◆ Ptxt() [8/10]

◆ Ptxt() [9/10]

◆ ~Ptxt()

◆ Ptxt() [10/10]

Member Function Documentation

◆ addConstant()

◆ addConstantCKKS()

◆ at() [1/2]

◆ at() [2/2]

◆ automorph() [1/3]

◆ automorph() [2/3]

◆ automorph() [3/3]

◆ cleanUp()

◆ clear()

◆ complexConj() [1/2]

◆ complexConj() [2/2]

◆ convertToSlot() [1/3]

◆ convertToSlot() [2/3]

◆ convertToSlot() [3/3]

◆ cube()

◆ decodeSetData() [1/2]

◆ decodeSetData() [2/2]

◆ encode() [1/3]

◆ encode() [2/3]

◆ encode() [3/3]

◆ frobeniusAutomorph() [1/2]

◆ frobeniusAutomorph() [2/2]

◆ getContext()

◆ getPolyRepr() [1/2]

◆ getPolyRepr() [2/2]

◆ getSlotRepr()

◆ imag() [1/2]

◆ imag() [2/2]

◆ incrementalProduct()

◆ isValid()

◆ lsize()

◆ mapTo01()

◆ multiplyBy()

◆ multiplyBy2()

◆ negate()

◆ operator!=()

◆ operator*()

◆ operator*=() [1/3]

◆ operator*=() [2/3]

◆ operator*=() [3/3]

◆ operator+()

◆ operator+=() [1/3]

◆ operator+=() [2/3]

◆ operator+=() [3/3]

◆ operator-()

◆ operator-=() [1/3]

◆ operator-=() [2/3]

◆ operator-=() [3/3]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ power()

◆ random()

◆ readFromJSON() [1/2]

◆ readFromJSON() [2/2]

◆ readJSON() [1/2]

template<typename Scheme>
class helib::Ptxt< Scheme >