org.cryptimeleon.math.structures.cartesian

Class Vector<X>

java.lang.Object

org.cryptimeleon.math.structures.cartesian.Vector<X>

Type Parameters:

X - the type of the vector elements

Direct Known Subclasses:

ExponentExpressionVector, GroupElementExpressionVector, GroupElementVector, RingElementVector

public class Vector<X>
extends java.lang.Object

A general vector class.

For specific instantiations of this class for group and ring elements, see GroupElementVector and RingElementVector.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<? extends X>	values

Constructor Summary

Constructors

Modifier	Constructor and Description
	Vector(java.util.List<? extends X> values)
protected	Vector(java.util.List<? extends X> values, boolean isSafe) Construct a new Vector using the given values which are assumed to be safe (promised to not be changed from the outside).
	Vector(Vector<? extends X> values)
	Vector(X... values)
protected	Vector(X[] values, boolean isSafe) Construct a new Vector using the given values which are assumed to be safe (promised to not be changed from the outside).

Method Summary

Modifier and Type	Method and Description
Vector<X>	append(X valueToAppend)
Vector<X>	concatenate(Vector<? extends X> secondPart)
boolean	equals(java.lang.Object o)
void	forEach(java.util.function.BiConsumer<java.lang.Integer,X> consumer)
void	forEach(java.util.function.Consumer<X> consumer)
protected static <Z,V extends Vector<Z>> V	fromStreamPlain(java.util.stream.Stream<? extends Z> stream, java.util.function.Function<java.util.List<Z>,V> vectorInstantiator)
static <Z> Vector<Z>	fromStreamPlain(java.util.stream.Stream<Z> stream)
static <Y> Vector<Y>	generatePlain(java.util.function.Function<java.lang.Integer,? extends Y> generator, int n) Generates a new Vector<Y> of length n by applying the generator function to each index.
static <Y,V extends Vector<Y>> V	generatePlain(java.util.function.Function<java.lang.Integer,? extends Y> generator, int n, java.util.function.Function<java.util.List<Y>,V> vectorInstantiator) Generates a new Vector V<Y> of length n by applying the generator function to each index.
static <Y> Vector<Y>	generatePlain(java.util.function.Supplier<? extends Y> generator, int n) Generates a new Vector<Y> of length n using the generator supplier.
static <Y,V extends Vector<Y>> V	generatePlain(java.util.function.Supplier<? extends Y> generator, int n, java.util.function.Function<java.util.List<Y>,V> vectorInstantiator) Generates a new Vector V<Y> of length n using the generator supplier.
X	get(int index)
int	hashCode()
static <Y> Vector<Y>	iterate(Y initialValue, java.util.function.Function<Y,Y> nextValue, int n) Constructs a new Vector<Y> with n elements by applying the nextValue function n times, storing each result in the resulting vector.
protected static <Y,V extends Vector<Y>> V	iterate(Y initialValue, java.util.function.Function<Y,Y> nextValue, int n, java.util.function.Function<java.util.List<Y>,V> vectorInstantiator) Constructs a new Vector V<Y> with n elements by applying the nextValue function n times, storing each result in the resulting vector.
int	length()
<Y> Vector<Y>	map(java.util.function.BiFunction<java.lang.Integer,X,Y> map)
<Y,V extends Vector<Y>> V	map(java.util.function.BiFunction<java.lang.Integer,X,Y> map, java.util.function.Function<java.util.List<Y>,? extends V> vectorInstantiator)
<Y> Vector<Y>	map(java.util.function.Function<X,Y> map)
<Y,V extends Vector<Y>> V	map(java.util.function.Function<X,Y> map, java.util.function.Function<java.util.List<Y>,? extends V> vectorInstantiator)
static GroupElementVector	of(GroupElement... vals) Construct a new GroupElementVector made up of the given group elements.
static RingElementVector	of(RingElement... vals) Construct a new RingElementVector made up of the given group elements.
static <Y> Vector<Y>	of(Y... vals) Construct a new Vector made up of the given values.
Vector<X>	pad(X valueToPadWith, int desiredLength)
Vector<X>	prepend(X valueToPrepend)
X	reduce(java.util.function.BinaryOperator<X> combiner)
X	reduce(java.util.function.BinaryOperator<X> combiner, X neutralElement)
Vector<X>	replace(int index, X substitute)
java.util.stream.Stream<? extends X>	stream()
java.util.List<X>	toList()
java.lang.String	toString()
Vector<X>	truncate(int newLength)
<Y,Z> Vector<Z>	zip(Vector<Y> other, java.util.function.BiFunction<X,Y,Z> combiner)
protected <Y,Z,V extends Vector<Z>> V	zip(Vector<Y> other, java.util.function.BiFunction<X,Y,Z> combiner, java.util.function.Function<java.util.List<Z>,V> vectorInstantiator)
<Y,Z> Z	zipReduce(Vector<Y> other, java.util.function.BiFunction<X,Y,Z> zipMap, java.util.function.BinaryOperator<Z> combiner) Equivalent to zip(other, zipMap).reduce(combiner, neutralElement)
<Y,Z> Z	zipReduce(Vector<Y> other, java.util.function.BiFunction<X,Y,Z> zipMap, java.util.function.BinaryOperator<Z> combiner, Z neutralElement) Equivalent to zip(other, zipMap).reduce(combiner, neutralElement)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

values

protected java.util.List<? extends X> values

Constructor Detail

Vector

public Vector(X... values)

Vector

public Vector(java.util.List<? extends X> values)

Vector

public Vector(Vector<? extends X> values)

Vector

protected Vector(X[] values,
                 boolean isSafe)

Construct a new Vector using the given values which are assumed to be safe (promised to not be changed from the outside).

Parameters:

values - the values to construct the new Vector from

isSafe - whether the given value array is "safe" in the sense that it is promised to not be changed from the outside afterwards

Vector

protected Vector(java.util.List<? extends X> values,
                 boolean isSafe)

Construct a new Vector using the given values which are assumed to be safe (promised to not be changed from the outside).

Parameters:

values - the values to construct the new Vector from

isSafe - whether the given value array is "safe" in the sense that it is promised to not be changed from the outside afterwards

Method Detail

of

public static <Y> Vector<Y> of(Y... vals)

Construct a new Vector made up of the given values.

Type Parameters:

Y - the type of the elements

Parameters:

vals - the values to use for constructing the new Vector

Returns:

a new Vector filled with the given elements

of

public static GroupElementVector of(GroupElement... vals)

Construct a new GroupElementVector made up of the given group elements.

Parameters:

vals - the values to use for constructing the new GroupElementVector

Returns:

a new GroupElementVector filled with the given elements

of

public static RingElementVector of(RingElement... vals)

Construct a new RingElementVector made up of the given group elements.

Parameters:

vals - the values to use for constructing the new RingElementVector

Returns:

a new RingElementVector filled with the given elements

iterate

public static <Y> Vector<Y> iterate(Y initialValue,
                                    java.util.function.Function<Y,Y> nextValue,
                                    int n)

Constructs a new Vector<Y> with n elements by applying the nextValue function n times, storing each result in the resulting vector.

Type Parameters:

Y - the type of the vector values

Parameters:

initialValue - the first value of the resulting vector and the basis for the successive values

nextValue - the function producing values for the resulting vector

n - the length of the resulting vector

Returns:

a new vector of lenghth n produced by iterative application of the nextValue function

See Also:

iterate(Object, Function, int, Function)

iterate

protected static <Y,V extends Vector<Y>> V iterate(Y initialValue,
                                                   java.util.function.Function<Y,Y> nextValue,
                                                   int n,
                                                   java.util.function.Function<java.util.List<Y>,V> vectorInstantiator)

Constructs a new Vector V<Y> with n elements by applying the nextValue function n times, storing each result in the resulting vector.

Type Parameters:

Y - the type of the vector values

V - the type of the vector itself

Parameters:

initialValue - the first value of the resulting vector and the basis for the successive values

nextValue - the function producing values for the resulting vector

n - the length of the resulting vector

vectorInstantiator - the function that instantiates the vector given a list of values

Returns:

a new vector of lenghth n produced by iterative application of the nextValue function

generatePlain

public static <Y> Vector<Y> generatePlain(java.util.function.Function<java.lang.Integer,? extends Y> generator,
                                          int n)

Generates a new Vector<Y> of length n by applying the generator function to each index.

Type Parameters:

Y - the type of the vector elements

Parameters:

generator - the function that creates the vector elements

n - the desired number of elements

Returns:

a new Vector<Y> of length n

generatePlain

public static <Y> Vector<Y> generatePlain(java.util.function.Supplier<? extends Y> generator,
                                          int n)

Generates a new Vector<Y> of length n using the generator supplier.

Type Parameters:

Y - the type of the vector elements

Parameters:

generator - the function that creates the vector elements

n - the desired number of elements

Returns:

a new Vector<Y> of length n

generatePlain

public static <Y,V extends Vector<Y>> V generatePlain(java.util.function.Function<java.lang.Integer,? extends Y> generator,
                                                      int n,
                                                      java.util.function.Function<java.util.List<Y>,V> vectorInstantiator)

Generates a new Vector V<Y> of length n by applying the generator function to each index.

Type Parameters:

Y - the type of the vector elements

V - the type of vector

Parameters:

generator - the function that creates the vector elements

n - the desired number of elements

vectorInstantiator - the function that instantiates the vector given a list of values

Returns:

a new Vector<Y> of length n

generatePlain

public static <Y,V extends Vector<Y>> V generatePlain(java.util.function.Supplier<? extends Y> generator,
                                                      int n,
                                                      java.util.function.Function<java.util.List<Y>,V> vectorInstantiator)

Generates a new Vector V<Y> of length n using the generator supplier.

Type Parameters:

Y - the type of the vector elements

V - the type of vector

Parameters:

generator - the function that creates the vector elements

n - the desired number of elements

vectorInstantiator - the function that instantiates the vector given a list of values

Returns:

a new Vector<Y> of length n

fromStreamPlain

protected static <Z,V extends Vector<Z>> V fromStreamPlain(java.util.stream.Stream<? extends Z> stream,
                                                           java.util.function.Function<java.util.List<Z>,V> vectorInstantiator)

fromStreamPlain

public static <Z> Vector<Z> fromStreamPlain(java.util.stream.Stream<Z> stream)

zip

protected <Y,Z,V extends Vector<Z>> V zip(Vector<Y> other,
                                          java.util.function.BiFunction<X,Y,Z> combiner,
                                          java.util.function.Function<java.util.List<Z>,V> vectorInstantiator)

zip

public <Y,Z> Vector<Z> zip(Vector<Y> other,
                           java.util.function.BiFunction<X,Y,Z> combiner)

map

public <Y,V extends Vector<Y>> V map(java.util.function.Function<X,Y> map,
                                     java.util.function.Function<java.util.List<Y>,? extends V> vectorInstantiator)

map

public <Y> Vector<Y> map(java.util.function.Function<X,Y> map)

map

public <Y,V extends Vector<Y>> V map(java.util.function.BiFunction<java.lang.Integer,X,Y> map,
                                     java.util.function.Function<java.util.List<Y>,? extends V> vectorInstantiator)

map

public <Y> Vector<Y> map(java.util.function.BiFunction<java.lang.Integer,X,Y> map)

forEach

public void forEach(java.util.function.Consumer<X> consumer)

forEach

public void forEach(java.util.function.BiConsumer<java.lang.Integer,X> consumer)

reduce

public X reduce(java.util.function.BinaryOperator<X> combiner)

reduce

public X reduce(java.util.function.BinaryOperator<X> combiner,
                X neutralElement)

zipReduce

public <Y,Z> Z zipReduce(Vector<Y> other,
                         java.util.function.BiFunction<X,Y,Z> zipMap,
                         java.util.function.BinaryOperator<Z> combiner,
                         Z neutralElement)

Equivalent to zip(other, zipMap).reduce(combiner, neutralElement)

zipReduce

public <Y,Z> Z zipReduce(Vector<Y> other,
                         java.util.function.BiFunction<X,Y,Z> zipMap,
                         java.util.function.BinaryOperator<Z> combiner)

Equivalent to zip(other, zipMap).reduce(combiner, neutralElement)

pad

public Vector<X> pad(X valueToPadWith,
                     int desiredLength)

append

public Vector<X> append(X valueToAppend)

prepend

public Vector<X> prepend(X valueToPrepend)

replace

public Vector<X> replace(int index,
                         X substitute)

truncate

public Vector<X> truncate(int newLength)

concatenate

public Vector<X> concatenate(Vector<? extends X> secondPart)

toList

public java.util.List<X> toList()

stream

public java.util.stream.Stream<? extends X> stream()

length

public int length()

get

public X get(int index)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object