BooleanElement (math 2.1.0 API)

java.lang.Object
- org.cryptimeleon.math.structures.rings.bool.BooleanElement

All Implemented Interfaces:

UniqueByteRepresentable, Representable, Element, RingElement
```
public class BooleanElement
extends java.lang.Object
implements RingElement
```
Element of BooleanStructure.

Field Summary

Fields
Modifier and Type	Field and Description
`static BooleanElement`	`FALSE` The `BooleanElement` corresponding to a `false` value.
`static BooleanElement`	`TRUE` The `BooleanElement` corresponding to a `true` value.
`protected boolean`	`value` The Boolean value represented by this `BooleanElement`.

Constructor Summary

Constructors
Constructor and Description

BooleanElement(boolean value)

BooleanElement(Representation repr)

Constructors
Constructor and Description
`BooleanElement(boolean value)`
`BooleanElement(Representation repr)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RingElement`	`add(Element e)` Returns result of calling Boolean XOR on this value and the argument.
`java.math.BigInteger`	`asInteger()` Interprets this element as an integer.
`boolean`	`divides(RingElement e)` Returns true iff there exists an \(x\) in the ring such that \(\text{this} \cdot x = e\).
`RingElement[]`	`divideWithRemainder(RingElement e)` Divides this by e with remainder, returning both quotient and remainder.
`boolean`	`equals(java.lang.Object obj)`
`java.math.BigInteger`	`getRank()` Implements the euclidean function of a euclidean domain.
`Representation`	`getRepresentation()` The representation of this object.
`Ring`	`getStructure()` Returns the `Structure` that this `Element` belongs to.
`int`	`hashCode()`
`RingElement`	`inv()` If this value is `TRUE`, returns `TRUE`; otherwise throws a `UnsupportedOperationException`.
`RingElement`	`mul(Element e)` Returns result of calling Boolean AND on this value and the argument.
`RingElement`	`neg()` Negates this Boolean value.
`BooleanElement`	`or(Element e)` Returns result of calling Boolean OR on this value and the argument.
`java.lang.String`	`toString()`
`ByteAccumulator`	`updateAccumulator(ByteAccumulator accumulator)` Updates the ByteAccumulator with the unique byte representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cryptimeleon.math.structures.rings.RingElement
div, isOne, isUnit, isZero, mul, mul, pow, pow, square, sub, toAdditiveGroupElement, toUnitGroupElement

Methods inherited from interface org.cryptimeleon.math.hash.UniqueByteRepresentable
getUniqueByteRepresentation

- Field Detail
  - value
```
protected boolean value
```
    The Boolean value represented by this BooleanElement.
  - TRUE
```
public static BooleanElement TRUE
```
    The BooleanElement corresponding to a true value.
  - FALSE
```
public static BooleanElement FALSE
```
    The BooleanElement corresponding to a false value.
- Constructor Detail
  - BooleanElement
```
public BooleanElement(boolean value)
```
  - BooleanElement
```
public BooleanElement(Representation repr)
```
- Method Detail
  - getStructure
```
public Ring getStructure()
```
    Description copied from interface: Element
    
    Returns the Structure that this Element belongs to.
    
    Specified by:
    
    getStructure in interface Element
    
    Specified by:
    
    getStructure in interface RingElement
  - add
```
public RingElement add(Element e)
```
    Returns result of calling Boolean XOR on this value and the argument.
    
    Specified by:
    
    add in interface RingElement
    
    Parameters:
    
    e - the addend
    
    Returns:
    
    the result
  - neg
```
public RingElement neg()
```
    Negates this Boolean value.
    
    Specified by:
    
    neg in interface RingElement
    
    Returns:
    
    TRUE if this value is FALSE, else FALSE
  - mul
```
public RingElement mul(Element e)
```
    Returns result of calling Boolean AND on this value and the argument.
    
    Specified by:
    
    mul in interface RingElement
    
    Parameters:
    
    e - the factor
    
    Returns:
    
    the result
  - inv
```
public RingElement inv()
                throws java.lang.UnsupportedOperationException
```
    If this value is TRUE, returns TRUE; otherwise throws a UnsupportedOperationException.
    FALSE is the zero element and therefore has no multiplicative inversion.
    
    Specified by:
    
    inv in interface RingElement
    
    Returns:
    
    the result
    
    Throws:
    
    java.lang.UnsupportedOperationException - if this value is FALSE
  - or
```
public BooleanElement or(Element e)
```
    Returns result of calling Boolean OR on this value and the argument.
  - divides
```
public boolean divides(RingElement e)
                throws java.lang.UnsupportedOperationException
```
    Description copied from interface: RingElement
    
    Returns true iff there exists an \(x\) in the ring such that \(\text{this} \cdot x = e\).
    
    Specified by:
    
    divides in interface RingElement
    
    Throws:
    
    java.lang.UnsupportedOperationException - if this cannot be decided (efficiently)
  - divideWithRemainder
```
public RingElement[] divideWithRemainder(RingElement e)
                                  throws java.lang.UnsupportedOperationException,
                                         java.lang.IllegalArgumentException
```
    Description copied from interface: RingElement
    
    Divides this by e with remainder, returning both quotient and remainder.
    Specifically, returns an array result such that the first entry contains the quotient and the second entry the remainder. Furthermore, result[1].getRank() < e.getRank() or result[1] = 0.
    This definition implies that the remainder is zero if and only if e divides this element.
    
    Specified by:
    
    divideWithRemainder in interface RingElement
    
    Throws:
    
    java.lang.UnsupportedOperationException - if the ring is not a euclidean domain
    
    java.lang.IllegalArgumentException - if e is zero
  - getRank
```
public java.math.BigInteger getRank()
                             throws java.lang.UnsupportedOperationException
```
    Description copied from interface: RingElement
    Implements the euclidean function of a euclidean domain.
    The euclidean function is a function from \(R \setminus \{0\}\) to \(\mathbb{N}_0\) such that
    - a.getRank() >= 0 for any a in the ring
    - a.mul(b).getRank() >= a.getRank() for any a, b != 0
    - the remainder rank after divideWithRemainder is less than the divisor's rank
    For example, for a polynomial ring this corresponds to the degree of the polynomial.
    The rank of the zero element is undefined (no guarantee as to what this method returns in that case).
    Specified by:
    
    getRank in interface RingElement
    
    Throws:
    
    java.lang.UnsupportedOperationException - if the ring is not a euclidean domain
  - updateAccumulator
```
public ByteAccumulator updateAccumulator(ByteAccumulator accumulator)
```
    Description copied from interface: UniqueByteRepresentable
    
    Updates the ByteAccumulator with the unique byte representation of this object.
    The input to the accumulators update function is an injective (with respect to a given domain) byte encoding of this object.
    For many use-cases, the AnnotatedUbrUtil can be used to quickly implement this method.
    
    Specified by:
    
    updateAccumulator in interface UniqueByteRepresentable
    
    Returns:
    
    the same accumulator as was input
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Element
    
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Specified by:
    
    equals in interface Element
    
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getRepresentation
```
public Representation getRepresentation()
```
    Description copied from interface: Representable
    
    The representation of this object. Used for serialization. A convenient way to implement this is using @link ReprUtil
    
    Specified by:
    
    getRepresentation in interface Representable
    
    Returns:
    
    a Representation or null if an equal object can be recreated without any information.
    
    See Also:
    
    Representation
  - asInteger
```
public java.math.BigInteger asInteger()
                               throws java.lang.UnsupportedOperationException
```
    Description copied from interface: RingElement
    
    Interprets this element as an integer.
    Formally, this method shall return the inverse of Ring.getElement(BigInteger), i.e. x.getStructure().getElement(x.asInteger()).equals(x) (if asInteger() doesn't throw an exception).
    
    Specified by:
    
    asInteger in interface RingElement
    
    Returns:
    
    the integer corresponding to this element
    
    Throws:
    
    java.lang.UnsupportedOperationException - if no such element exists or cannot be efficiently computed

Class BooleanElement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.cryptimeleon.math.structures.rings.RingElement

Methods inherited from interface org.cryptimeleon.math.hash.UniqueByteRepresentable

Field Detail

value

TRUE

FALSE

Constructor Detail

BooleanElement

BooleanElement

Method Detail

getStructure

add

neg

mul

inv

or

divides

divideWithRemainder

getRank

updateAccumulator

hashCode

equals

toString

getRepresentation

asInteger