Generated with

cats-eo-api-docs/dev.constructive.eo/dev.constructive.eo.data/PSVec

PSVec

dev.constructive.eo.data.PSVec

See thePSVec companion object

sealed trait PSVec[+B]

Lightweight array-backed focus vector underlying MultiFocus[PSVec]. Three variants so empty and singleton focus vectors don't pay a backing-array allocation:

PSVec.Empty — shared singleton; Prism / Affine miss branches allocate nothing.
PSVec.Single — element stored inline (~16 B vs a backing-array view's ~40 B).
PSVec.Slice — arbitrary (arr, offset, length) view. slice is a zero-copy pointer update — what mfAssocPSVec.composeFrom relies on for O(1) per-element reassembly.

Equality is value-based across variants.

Attributes

Companion: object
Source: PSVec.scala
Graph
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object Empty

class Single[B]

class Slice[B]

Members list

Value members

Abstract methods

Indexed access. Unchecked: UB if i < 0 || i >= length.

Attributes

Source: PSVec.scala

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

Attributes

Source: PSVec.scala

Attributes

Source: PSVec.scala

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

Attributes

Source: PSVec.scala

Concrete methods

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: Any
Source: PSVec.scala

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: Any
Source: PSVec.scala

Attributes

Source: PSVec.scala

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

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

Attributes

Source: PSVec.scala

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns: a string representation of the object.
Definition Classes: Any
Source: PSVec.scala

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

Source: PSVec.scala

In this article

Generated with