cats-eo-api-docs
0.8.1-3-6c70289-SNAPSHOT
API
Generated with
cats-eo-api-docs/dev.constructive.eo/dev.constructive.eo.data/PSVec/Empty

Empty

dev.constructive.eo.data.PSVec.Empty
case object Empty extends PSVec[Nothing]

Zero-element shared singleton; Prism / Affine miss branches allocate nothing.

Attributes

Source
PSVec.scala
Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait PSVec[Nothing]
class Object
trait Matchable
class Any
Show all
Self type
Empty.type

Members list

Type members

Inherited types

type MirroredElemLabels = EmptyTuple

The names of the product elements.

The names of the product elements.

Attributes

Inherited from:
Singleton
Source
Mirror.scala
type MirroredElemTypes = EmptyTuple

Attributes

Inherited from:
Singleton
Source
Mirror.scala
type MirroredMonoType = this.type

The mirrored *-type.

The mirrored *-type.

Attributes

Inherited from:
Singleton
Source
Mirror.scala
type MirroredType = this.type

Attributes

Inherited from:
Singleton
Source
Mirror.scala

Inherited and Abstract types

type MirroredLabel <: String

The name of the type.

The name of the type.

Attributes

Inherited from:
Mirror
Source
Mirror.scala

Value members

Concrete methods

def apply(i: Int): Nothing

Indexed access. Unchecked: UB if i &lt; 0 || i >= length.

Indexed access. Unchecked: UB if i &lt; 0 || i >= length.

Attributes

Source
PSVec.scala
def head: Nothing

Read the first element. Unchecked: UB if length == 0.

Read the first element. Unchecked: UB if length == 0.

Attributes

Source
PSVec.scala
def length: Int

Attributes

Source
PSVec.scala
def slice(from: Int, until: Int): PSVec[Nothing]

Zero-copy view [from, until), clamped to this vector's bounds.

Zero-copy view [from, until), clamped to this vector's bounds.

Attributes

Source
PSVec.scala

Inherited methods

override def equals(that: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
PSVec -> Any
Inherited from:
PSVec
Source
PSVec.scala
def fromProduct(p: Product): MirroredMonoType

Creates a new instance of type T with elements taken from product p.

Creates a new instance of type T with elements taken from product p.

Attributes

Inherited from:
Singleton
Source
Mirror.scala
override def hashCode(): Int

Calculates a hash code value for the object.

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
PSVec -> Any
Inherited from:
PSVec
Source
PSVec.scala
inline def isEmpty: Boolean

Attributes

Inherited from:
PSVec
Source
PSVec.scala
def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
Source
Product.scala
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product
Source
Product.scala
def toList: List[Nothing]

Materialise as a List — the read-side bridge for Plated.children / universe and the carriers (circe / avro) that reconstruct from an ordered sequence.

Materialise as a List — the read-side bridge for Plated.children / universe and the carriers (circe / avro) that reconstruct from an ordered sequence.

Attributes

Inherited from:
PSVec
Source
PSVec.scala
override def toString(): String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
PSVec -> Any
Inherited from:
PSVec
Source
PSVec.scala
def unsafeShareableArray: Array[AnyRef]

Like toAnyRefArray but MAY share the backing array zero-copy when a dense Slice covers its full range. Callers MUST treat the result as immutable. Used by consumers that also won't mutate, e.g. optics.Traversal.pEach's from → ArraySeq.unsafeWrapArray). Default is the safe copy; only Slice overrides to share.

Like toAnyRefArray but MAY share the backing array zero-copy when a dense Slice covers its full range. Callers MUST treat the result as immutable. Used by consumers that also won't mutate, e.g. optics.Traversal.pEach's from → ArraySeq.unsafeWrapArray). Default is the safe copy; only Slice overrides to share.

Attributes

Inherited from:
PSVec
Source
PSVec.scala

Concrete fields

override val toAnyRefArray: Array[AnyRef]

Materialise as a fresh Array[AnyRef]. Slice overrides with System.arraycopy (intrinsic) so the common rebuild path in Traversal.pEach's from is one memcpy.

Materialise as a fresh Array[AnyRef]. Slice overrides with System.arraycopy (intrinsic) so the common rebuild path in Traversal.pEach's from is one memcpy.

Attributes

Source
PSVec.scala
Generated with