Buffer

abstract class Buffer[A] extends Idx.Mutable[A] with Able.Contain[A]

Value Buffer

Buffer is the default implementation of Mutable Indexed Collection

Source
__.scala
trait Idx.Mutable[A]
trait Able.Contain[A]
trait Able.Add[A]
trait Idx[A]
trait Collection[A]
trait Able.Size
trait Able.~[A]
class java.lang.Object
trait scala.Matchable
class Any

Def

@scala.annotation.targetName("stream")
def ~: ~[A]

Returns a Stream of all elements

Returns a Stream of all elements

The element order is same as in the Idx itself

  val l: Idx[Char] = ('a' <> 'g').~.><

  l.~.tp  // Prints ~(a, b, c, d, e, f, g)
Inherited from
Idx
Source
__.scala
@scala.annotation.targetName("_addOpt")
def ++=(v: Opt[A]): Buffer[A]

Alias for addAll

Alias for addAll

Generally Opt could be added as a stream.

This overload is sligtly more efficient, but it also required for mapped Opt expressions, where Opt type is harder to resolve and it would not compile.

Inherited from
Add
Source
Add.scala
@scala.annotation.targetName("_addAll")
def ++=(v: ~[A]): Buffer[A]

Alias for addAll

Alias for addAll

Calls addAll and returns container

 // Generic example
 val x =  Idx.M(1, 2, 3)

 x ++= (4 <> 6) ++= ~~(7, 8, 9)

 x.~.tp // ~~(1, 2, 3, 4, 5, 6, 7, 8, 9)
Inherited from
Add
Source
Add.scala
@scala.annotation.targetName("_addAllAt")
def ++=@(position: Int, v: ~[A]): Buffer[A]

Alias for addAllAt

Alias for addAllAt

Adds stream elements at given position

  // Generic example
  val x = ('A' <> 'F').~.toBuffer

  x ++=@ (4, 'e' <> 'g') ++=@ (1, ~~('b','c','d'))

  x.~.tp // Prints ~(A, b, c, d, B, C, D, e, f, g, E, F)
Inherited from
Mutable
Source
__.scala
@scala.annotation.targetName("_add")
def +=(v: A): Buffer[A]

Alias for add

Alias for add

Calls add and returns container

 // Generic example
 val x =  Idx.M(1, 2, 3)

  x += 4 += 5 += 6

  x.~.tp // Prints ~(1, 2, 3, 4, 5, 6)
Inherited from
Add
Source
Add.scala
@scala.annotation.targetName("_addAt")
def +=@(position: Int, v: A): Buffer[A]

Alias for addAt

Alias for addAt

Adds element at given position

  // Generic example
  val x = ('A' <> 'F').~.toBuffer

  x +=@ (3, 'd') +=@ (2, 'c') +=@ (1, 'b') +=@ (0, 'a')

  x.~.tp // Prints ~(a, A, b, B, c, C, d, D, E, F)
Inherited from
Mutable
Source
__.scala
@scala.annotation.targetName("_removeAll")
def --=(v: ~[A]): Buffer[A]

Alias for removeAll

Alias for removeAll

Removes all collection elements, which are equal to those in given stream

Returns the collection itself

Inherited from
Mutable
Source
Mutable.scala
@scala.annotation.targetName("_remove")
def -=(v: A): Buffer[A]

Alias for remove

Alias for remove

Removes all collection elements, which are equal to the given value

Returns the collection itself

Inherited from
Mutable
Source
Mutable.scala
@scala.annotation.targetName("pack")
def ><: ><[A]

Pack Buffer elements

Pack Buffer elements

Both Buffer and Pack are mostly Array based, so the direct convertions between them are very efficient

Source
__.scala
def add(v: A): Unit

Append element

Append element

Adds given element to the end of this Idx

Inherited from
Mutable
Source
__.scala
override def addAll(v: ~[A]): Unit

Append Stream

Append Stream

Adds all elements to Buffer end

Definition Classes
Source
__.scala
override def addAllAt(i: Int, v: ~[A]): Unit

Insert Stream

Insert Stream

Inserts all elements at specified buffer position

Definition Classes
Source
__.scala
final def addArray_trusted(a: Array[A], start: Int, len: Int): Unit

Add array elements

Add array elements

Programms are expected to pass even private sensitive arrays, because this method is final and can be exemined not to abuse the trust

The given arguments specify range of elements to be added.

Whenever possible the adding will be done with bulk copy from given array to buffer array

Source
__.scala
def addAt(position: Int, v: A): Unit

Add at position

Add at position

Adds element at given position

  // Generic example
  val x = ('A' <> 'F').~.toBuffer

  x.addAt(3, 'd')
  x.addAt(2, 'c')
  x.addAt(1, 'b')
  x.addAt(0, 'a')

  x.~.tp // Prints ~(a, A, b, B, c, C, d, D, E, F)
Inherited from
Mutable
Source
__.scala
def apply(i: Int): A

Returns element at specified position

Returns element at specified position

 val idx: Idx[Char] = ('A' <> 'Z').~.><

 idx(1).tp // Prints: B

 idx(4).tp // Prints: E
Inherited from
Idx
Source
__.scala
override def clear: Unit

Empty buffer

Empty buffer

Note. Even buffer becomes zero sized, the storage array will not shrink and will still reference the old elements (untill overwritten with new).

Definition Classes
Source
__.scala
def contains(v: A): Boolean

Check if contains

Check if contains

Returns true if given element is contained by the implementing container

Inherited from
Contain
Source
Contain.scala
override def isEmpty: Boolean

Empty check

Empty check

Returns true if instance is empty.

Definition Classes
Inherited from
Size
Source
Size.scala
def remove(v: A): Int

Remove element

Remove element

Removes all Idx elements, which are equal to the given value

Returns count of removed elements, which can be 0, 1, or many

Inherited from
Mutable
Source
__.scala
@scala.annotation.targetName("remove_Range")
def remove_<>(v: Int.<>): Unit

Remove range

Remove range

Removes elements at given range

 val x = (0 <> 10).~.toBuffer

 x.remove(7 <> 8)
 x.remove(2 <> 4)

 x.~.tp // Prints ~(0, 1, 5, 6, 9, 10)
Source
__.scala
def removeAll(v: ~[A]): Int

Remove all streamed

Remove all streamed

Removes all collection elements, which are equal to those in given stream

Returns count of removed elements, which can be 0, 1, or many

Inherited from
Mutable
Source
Mutable.scala
def removeAt(position: Int): Unit

Remove at position

Remove at position

Removes element at given position

 // Generic example
 val x = ('A' <> 'D').~.toBuffer

 x.remove(2)
 x.remove(1)

 x.~.tp // Prints ~(A, D)
Inherited from
Mutable
Source
__.scala
def replaceAll(v: ~[A]): Unit

Replace everything

Replace everything

Discards all old elements and adds all provided elements

Inherited from
Mutable
Source
Mutable.scala

Reorganizes elements

Reorganizes elements

Reorganizes elements according to the given permutation

  val im: Idx.Mutable[Int] = (0 <> 9).~.toBuffer

  val p = Idx.Permutation.pairs(3 -> 7, 7 -> 3, 4 -> 6, 6 -> 4)

  im.~.tp
  im.reposition(p)
  im.~.tp

  // Output
  ~(0, 1, 2, 3, 4, 5, 6, 7, 8, 9)
  ~(0, 1, 2, 7, 6, 5, 4, 3, 8, 9)
Inherited from
Mutable
Source
__.scala
override def size: Int

Element count

Element count

Retuns element count

Definition Classes
Inherited from
Idx
Source
__.scala
def sort(using c: scala.Ordering[A]): Unit

Sort elements

Sort elements

Sorts elements in this container

Inherited from
Mutable
Source
__.scala
def updateAllAt(position: Int, s: ~[A]): Unit

Update many at position

Update many at position

Replaces elements starting at given position with stream values

Inherited from
Mutable
Source
__.scala
def updateAt(position: Int, s: A): Unit

Update at position

Update at position

Replaces element at given position with given value

  val im: Idx.Mutable[Int] = (0 <> 7).~.toBuffer

  im.updateAt(7, 777)
  im.updateAt(3, 333)

  im.~.tp // Prints ~(0, 1, 2, 333, 4, 5, 6, 777)

  // The same can be done with Scala symplified syntax

  im(7) = 777
  im(3) = 333

Inherited from
Mutable
Source
__.scala