Ribs

Appearance

ribs_core›Classes›IVectorBuilder<A>

IVectorBuilder<A> final ​

final class IVectorBuilder<A>

A mutable builder for constructing IVector instances efficiently.

Accumulate elements with addOne and addAll, then call result to produce the immutable vector. The builder may be reused after calling clear.

Obtain an instance via IVector.builder.

Constructors ​

IVectorBuilder() ​

IVectorBuilder()

Properties ​

hashCode no setter inherited ​

int get hashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

Implementation
dart
external int get hashCode;

isEmpty no setter ​

bool get isEmpty

Whether no elements have been accumulated yet.

Implementation
dart
bool get isEmpty => knownSize() == 0;

nonEmpty no setter ​

bool get nonEmpty

Whether at least one element has been accumulated.

Implementation
dart
bool get nonEmpty => knownSize() != 0;

runtimeType no setter inherited ​

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation
dart
external Type get runtimeType;

Methods ​

addAll() ​

IVectorBuilder<A> addAll(RIterableOnce<A> xs)

Appends all elements from xs to this builder and returns this.

When xs is an IVector, the internal trie structure is reused where possible for efficiency.

Implementation
dart
IVectorBuilder<A> addAll(RIterableOnce<A> xs) {
  if (xs is IVector) {
    if (_len1 == 0 && _lenRest == 0 && !_prefixIsRightAligned) {
      return _initFromVector(xs as IVector<A>);
    } else {
      return _addVector(xs as IVector<A>);
    }
  } else {
    final it = xs.iterator;
    while (it.hasNext) {
      addOne(it.next());
    }
  }

  return this;
}

addOne() ​

IVectorBuilder<A> addOne(A elem)

Appends a single element elem to this builder and returns this.

Implementation
dart
IVectorBuilder<A> addOne(A elem) {
  if (_len1 == _WIDTH) _advance();

  _a1[_len1] = elem;

  _len1 += 1;
  return this;
}

clear() ​

void clear()

Resets this builder to an empty state so it can be reused.

Implementation
dart
void clear() {
  _a6 = null;
  _a5 = null;
  _a4 = null;
  _a3 = null;
  _a2 = null;
  _a1 = _arr1(_WIDTH);
  _len1 = 0;
  _lenRest = 0;
  _offset = 0;
  _prefixIsRightAligned = false;
  _depth = 1;
}

knownSize() ​

int knownSize()

The number of elements accumulated so far.

Implementation
dart
int knownSize() => _len1 + _lenRest - _offset;

noSuchMethod() inherited ​

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dart
dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

dart
class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation
dart
@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

result() ​

IVector<A> result()

Returns the IVector containing all elements added so far.

The builder's state is preserved after this call; use clear before adding more elements if you intend to reuse it.

Implementation
dart
IVector<A> result() {
  if (_prefixIsRightAligned) _leftAlignPrefix();

  final len = _len1 + _lenRest;
  final realLen = len - _offset;

  if (realLen == 0) {
    return IVector.empty();
  } else if (len < 0) {
    throw RangeError('Vector cannot have negative size $len');
  } else if (len <= _WIDTH) {
    return _Vector1(_copyIfDifferentSize(_a1, realLen));
  } else if (len <= _WIDTH2) {
    final i1 = (len - 1) & _MASK;
    final i2 = (len - 1) >>> _BITS;
    final data = Array.copyOfRange(_a2!, 1, i2);
    final prefix1 = _a2![0]!;
    final suffix1 = _copyIfDifferentSize(_a2![i2]!, i1 + 1);
    return _Vector2(prefix1, _WIDTH - _offset, data, suffix1, realLen);
  } else if (len <= _WIDTH3) {
    final i1 = (len - 1) & _MASK;
    final i2 = ((len - 1) >>> _BITS) & _MASK;
    final i3 = (len - 1) >>> _BITS2;
    final data = Array.copyOfRange(_a3!, 1, i3);
    final prefix2 = _copyTail(_a3![0]!);
    final prefix1 = _a3![0]![0]!;
    final suffix2 = Array.copyOf(_a3![i3]!, i2);
    final suffix1 = _copyIfDifferentSize(_a3![i3]![i2]!, i1 + 1);
    final len1 = prefix1.length;
    final len12 = len1 + prefix2.length * _WIDTH;
    return _Vector3(prefix1, len1, prefix2, len12, data, suffix2, suffix1, realLen);
  } else if (len <= _WIDTH4) {
    final i1 = (len - 1) & _MASK;
    final i2 = ((len - 1) >>> _BITS) & _MASK;
    final i3 = ((len - 1) >>> _BITS2) & _MASK;
    final i4 = (len - 1) >>> _BITS3;
    final data = Array.copyOfRange(_a4!, 1, i4);
    final prefix3 = _copyTail(_a4![0]!);
    final prefix2 = _copyTail(_a4![0]![0]!);
    final prefix1 = _a4![0]![0]![0]!;
    final suffix3 = Array.copyOf(_a4![i4]!, i3);
    final suffix2 = Array.copyOf(_a4![i4]![i3]!, i2);
    final suffix1 = _copyIfDifferentSize(_a4![i4]![i3]![i2]!, i1 + 1);
    final len1 = prefix1.length;
    final len12 = len1 + prefix2.length * _WIDTH;
    final len123 = len12 + prefix3.length * _WIDTH2;

    return _Vector4(
      prefix1,
      len1,
      prefix2,
      len12,
      prefix3,
      len123,
      data,
      suffix3,
      suffix2,
      suffix1,
      realLen,
    );
  } else if (len <= _WIDTH5) {
    final i1 = (len - 1) & _MASK;
    final i2 = ((len - 1) >>> _BITS) & _MASK;
    final i3 = ((len - 1) >>> _BITS2) & _MASK;
    final i4 = ((len - 1) >>> _BITS3) & _MASK;
    final i5 = (len - 1) >>> _BITS4;
    final data = Array.copyOfRange(_a5!, 1, i5);
    final prefix4 = _copyTail(_a5![0]!);
    final prefix3 = _copyTail(_a5![0]![0]!);
    final prefix2 = _copyTail(_a5![0]![0]![0]!);
    final prefix1 = _a5![0]![0]![0]![0]!;
    final suffix4 = Array.copyOf(_a5![i5]!, i4);
    final suffix3 = Array.copyOf(_a5![i5]![i4]!, i3);
    final suffix2 = Array.copyOf(_a5![i5]![i4]![i3]!, i2);
    final suffix1 = _copyIfDifferentSize(_a5![i5]![i4]![i3]![i2]!, i1 + 1);
    final len1 = prefix1.length;
    final len12 = len1 + prefix2.length * _WIDTH;
    final len123 = len12 + prefix3.length * _WIDTH2;
    final len1234 = len123 + prefix4.length * _WIDTH3;
    return _Vector5(
      prefix1,
      len1,
      prefix2,
      len12,
      prefix3,
      len123,
      prefix4,
      len1234,
      data,
      suffix4,
      suffix3,
      suffix2,
      suffix1,
      realLen,
    );
  } else {
    final i1 = (len - 1) & _MASK;
    final i2 = ((len - 1) >>> _BITS) & _MASK;
    final i3 = ((len - 1) >>> _BITS2) & _MASK;
    final i4 = ((len - 1) >>> _BITS3) & _MASK;
    final i5 = ((len - 1) >>> _BITS4) & _MASK;
    final i6 = (len - 1) >>> _BITS5;
    final data = Array.copyOfRange(_a6!, 1, i6);
    final prefix5 = _copyTail(_a6![0]!);
    final prefix4 = _copyTail(_a6![0]![0]!);
    final prefix3 = _copyTail(_a6![0]![0]![0]!);
    final prefix2 = _copyTail(_a6![0]![0]![0]![0]!);
    final prefix1 = _a6![0]![0]![0]![0]![0]!;
    final suffix5 = Array.copyOf(_a6![i6]!, i5);
    final suffix4 = Array.copyOf(_a6![i6]![i5]!, i4);
    final suffix3 = Array.copyOf(_a6![i6]![i5]![i4]!, i3);
    final suffix2 = Array.copyOf(_a6![i6]![i5]![i4]![i3]!, i2);
    final suffix1 = _copyIfDifferentSize(_a6![i6]![i5]![i4]![i3]![i2]!, i1 + 1);
    final len1 = prefix1.length;
    final len12 = len1 + prefix2.length * _WIDTH;
    final len123 = len12 + prefix3.length * _WIDTH2;
    final len1234 = len123 + prefix4.length * _WIDTH3;
    final len12345 = len1234 + prefix5.length * _WIDTH4;
    return _Vector6(
      prefix1,
      len1,
      prefix2,
      len12,
      prefix3,
      len123,
      prefix4,
      len1234,
      prefix5,
      len12345,
      data,
      suffix5,
      suffix4,
      suffix3,
      suffix2,
      suffix1,
      realLen,
    );
  }
}

setLen() ​

void setLen(int i)
Implementation
dart
void setLen(int i) {
  _len1 = i & _MASK;
  _lenRest = i - _len1;
}

size() ​

int size()

The number of elements accumulated so far. Alias for knownSize.

Implementation
dart
int size() => knownSize();

toString() inherited ​

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

Implementation
dart
external String toString();

Operators ​

operator ==() inherited ​

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

  • Total: It must return a boolean for all arguments. It should never throw.

  • Reflexive: For all objects o, o == o must be true.

  • Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

  • Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

Implementation
dart
external bool operator ==(Object other);