# BitVector

#### class BitVector extends Vector[Boolean] with VectorLike[Boolean, BitVector]

TODO @ dwhl: What does enforceLength exactly do?

Linear Supertypes
Vector[Boolean], VectorLike[Boolean, BitVector], Tensor[Int, Boolean], TensorLike[Int, Boolean, BitVector], NumericOps[BitVector], QuasiTensor[Int, Boolean], AnyRef, Any
Ordering
1. Alphabetic
2. By inheritance
Inherited
1. BitVector
2. Vector
3. VectorLike
4. Tensor
5. TensorLike
6. NumericOps
7. QuasiTensor
8. AnyRef
9. Any
1. Hide All
2. Show all
Visibility
1. Public
2. All

### Value Members

1. #### final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
2. #### final def !=(arg0: Any): Boolean

Definition Classes
Any
3. #### final def ##(): Int

Definition Classes
AnyRef → Any
4. #### final def %[TT >: BitVector, B, That](b: B)(implicit op: operators.OpMod.Impl2[TT, B, That]): That

Alias for :%(b) when b is a scalar.

Alias for :%(b) when b is a scalar.

Definition Classes
NumericOps
5. #### final def %=[TT >: BitVector, B](b: B)(implicit op: operators.OpMod.InPlaceImpl2[TT, B]): BitVector

Alias for :%=(b) when b is a scalar.

Alias for :%=(b) when b is a scalar.

Definition Classes
NumericOps
6. #### final def &[TT >: BitVector, B, That](b: B)(implicit op: operators.OpAnd.Impl2[TT, B, That]): That

Alias for :&&(b) for all b.

Alias for :&&(b) for all b.

Definition Classes
NumericOps
7. #### final def &=[TT >: BitVector, B](b: B)(implicit op: operators.OpAnd.InPlaceImpl2[TT, B]): BitVector

Mutates this by element-wise and of this and b.

Mutates this by element-wise and of this and b.

Definition Classes
NumericOps
8. #### final def *[TT >: BitVector, B, That](b: B)(implicit op: operators.OpMulMatrix.Impl2[TT, B, That]): That

Matrix multiplication

Matrix multiplication

Definition Classes
NumericOps
9. #### final def *=[TT >: BitVector, B](b: B)(implicit op: operators.OpMulScalar.InPlaceImpl2[TT, B]): BitVector

Alias for :*=(b) when b is a scalar.

Alias for :*=(b) when b is a scalar.

Definition Classes
NumericOps
10. #### final def +[TT >: BitVector, B, That](b: B)(implicit op: operators.OpAdd.Impl2[TT, B, That]): That

Alias for :+(b) for all b.

Alias for :+(b) for all b.

Definition Classes
NumericOps
11. #### final def +=[TT >: BitVector, B](b: B)(implicit op: operators.OpAdd.InPlaceImpl2[TT, B]): BitVector

Alias for :+=(b) for all b.

Alias for :+=(b) for all b.

Definition Classes
NumericOps
12. #### final def -[TT >: BitVector, B, That](b: B)(implicit op: operators.OpSub.Impl2[TT, B, That]): That

Alias for :-(b) for all b.

Alias for :-(b) for all b.

Definition Classes
NumericOps
13. #### final def -=[TT >: BitVector, B](b: B)(implicit op: operators.OpSub.InPlaceImpl2[TT, B]): BitVector

Alias for :-=(b) for all b.

Alias for :-=(b) for all b.

Definition Classes
NumericOps
14. #### final def /[TT >: BitVector, B, That](b: B)(implicit op: operators.OpDiv.Impl2[TT, B, That]): That

Alias for :/(b) when b is a scalar.

Alias for :/(b) when b is a scalar.

Definition Classes
NumericOps
15. #### final def /=[TT >: BitVector, B](b: B)(implicit op: operators.OpDiv.InPlaceImpl2[TT, B]): BitVector

Alias for :/=(b) when b is a scalar.

Alias for :/=(b) when b is a scalar.

Definition Classes
NumericOps
16. #### final def :!=[TT >: BitVector, B, That](b: B)(implicit op: operators.OpNe.Impl2[TT, B, That]): That

Element-wise inequality comparator of this and b.

Element-wise inequality comparator of this and b.

Definition Classes
NumericOps
17. #### final def :%[TT >: BitVector, B, That](b: B)(implicit op: operators.OpMod.Impl2[TT, B, That]): That

Element-wise modulo of this and b.

Element-wise modulo of this and b.

Definition Classes
NumericOps
18. #### final def :%=[TT >: BitVector, B](b: B)(implicit op: operators.OpMod.InPlaceImpl2[TT, B]): BitVector

Mutates this by element-wise modulo of b into this.

Mutates this by element-wise modulo of b into this.

Definition Classes
NumericOps
19. #### final def :&[TT >: BitVector, B, That](b: B)(implicit op: operators.OpAnd.Impl2[TT, B, That]): That

Element-wise logical "and" operator -- returns true if corresponding elements are non-zero.

Element-wise logical "and" operator -- returns true if corresponding elements are non-zero.

Definition Classes
NumericOps
20. #### final def :&=[TT >: BitVector, B](b: B)(implicit op: operators.OpAnd.InPlaceImpl2[TT, B]): BitVector

Mutates this by element-wise and of this and b.

Mutates this by element-wise and of this and b.

Definition Classes
NumericOps
21. #### final def :*[TT >: BitVector, B, That](b: B)(implicit op: operators.OpMulScalar.Impl2[TT, B, That]): That

Element-wise product of this and b.

Element-wise product of this and b.

Definition Classes
NumericOps
22. #### final def :*=[TT >: BitVector, B](b: B)(implicit op: operators.OpMulScalar.InPlaceImpl2[TT, B]): BitVector

Mutates this by element-wise multiplication of b into this.

Mutates this by element-wise multiplication of b into this.

Definition Classes
NumericOps
23. #### final def :+[TT >: BitVector, B, That](b: B)(implicit op: operators.OpAdd.Impl2[TT, B, That]): That

Element-wise sum of this and b.

Element-wise sum of this and b.

Definition Classes
NumericOps
24. #### final def :+=[TT >: BitVector, B](b: B)(implicit op: operators.OpAdd.InPlaceImpl2[TT, B]): BitVector

Mutates this by element-wise addition of b into this.

Mutates this by element-wise addition of b into this.

Definition Classes
NumericOps
25. #### final def :-[TT >: BitVector, B, That](b: B)(implicit op: operators.OpSub.Impl2[TT, B, That]): That

Element-wise difference of this and b.

Element-wise difference of this and b.

Definition Classes
NumericOps
26. #### final def :-=[TT >: BitVector, B](b: B)(implicit op: operators.OpSub.InPlaceImpl2[TT, B]): BitVector

Mutates this by element-wise subtraction of b from this

Mutates this by element-wise subtraction of b from this

Definition Classes
NumericOps
27. #### final def :/[TT >: BitVector, B, That](b: B)(implicit op: operators.OpDiv.Impl2[TT, B, That]): That

Element-wise quotient of this and b.

Element-wise quotient of this and b.

Definition Classes
NumericOps
28. #### final def :/=[TT >: BitVector, B](b: B)(implicit op: operators.OpDiv.InPlaceImpl2[TT, B]): BitVector

Mutates this by element-wise division of b into this

Mutates this by element-wise division of b into this

Definition Classes
NumericOps
29. #### final def :<[TT >: BitVector, B, That](b: B)(implicit op: operators.OpLT.Impl2[TT, B, That]): That

Element-wise less=than comparator of this and b.

Element-wise less=than comparator of this and b.

Definition Classes
NumericOps
30. #### final def :<=[TT >: BitVector, B, That](b: B)(implicit op: operators.OpLTE.Impl2[TT, B, That]): That

Element-wise less-than-or-equal-to comparator of this and b.

Element-wise less-than-or-equal-to comparator of this and b.

Definition Classes
NumericOps
31. #### final def :=[TT >: BitVector, B](b: B)(implicit op: operators.OpSet.InPlaceImpl2[TT, B]): BitVector

Mutates this by element-wise assignment of b into this.

Mutates this by element-wise assignment of b into this.

Definition Classes
NumericOps
32. #### final def :==[TT >: BitVector, B, That](b: B)(implicit op: operators.OpEq.Impl2[TT, B, That]): That

Element-wise equality comparator of this and b.

Element-wise equality comparator of this and b.

Definition Classes
NumericOps
33. #### final def :>[TT >: BitVector, B, That](b: B)(implicit op: operators.OpGT.Impl2[TT, B, That]): That

Element-wise greater-than comparator of this and b.

Element-wise greater-than comparator of this and b.

Definition Classes
NumericOps
34. #### final def :>=[TT >: BitVector, B, That](b: B)(implicit op: operators.OpGTE.Impl2[TT, B, That]): That

Element-wise greater-than-or-equal-to comparator of this and b.

Element-wise greater-than-or-equal-to comparator of this and b.

Definition Classes
NumericOps
35. #### final def :^[TT >: BitVector, B, That](b: B)(implicit op: operators.OpPow.Impl2[TT, B, That]): That

Element-wise exponentiation of this and b.

Element-wise exponentiation of this and b.

Definition Classes
NumericOps
36. #### final def :^=[TT >: BitVector, B](b: B)(implicit op: operators.OpPow.InPlaceImpl2[TT, B]): BitVector

Mutates this by element-wise exponentiation of this by b.

Mutates this by element-wise exponentiation of this by b.

Definition Classes
NumericOps
37. #### final def :^^[TT >: BitVector, B, That](b: B)(implicit op: operators.OpXor.Impl2[TT, B, That]): That

Element-wise logical "xor" operator -- returns true if only one of the corresponding elements is non-zero.

Element-wise logical "xor" operator -- returns true if only one of the corresponding elements is non-zero.

Definition Classes
NumericOps
38. #### final def :^^=[TT >: BitVector, B](b: B)(implicit op: operators.OpXor.InPlaceImpl2[TT, B]): BitVector

Mutates this by element-wise xor of this and b.

Mutates this by element-wise xor of this and b.

Definition Classes
NumericOps
39. #### final def :|[TT >: BitVector, B, That](b: B)(implicit op: operators.OpOr.Impl2[TT, B, That]): That

Element-wise logical "or" operator -- returns true if either element is non-zero.

Element-wise logical "or" operator -- returns true if either element is non-zero.

Definition Classes
NumericOps
40. #### final def :|=[TT >: BitVector, B](b: B)(implicit op: operators.OpOr.InPlaceImpl2[TT, B]): BitVector

Mutates this by element-wise or of this and b.

Mutates this by element-wise or of this and b.

Definition Classes
NumericOps
41. #### final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
42. #### final def ==(arg0: Any): Boolean

Definition Classes
Any
43. #### def \[TT >: BitVector, B, That](b: B)(implicit op: operators.OpSolveMatrixBy.Impl2[TT, B, That]): That

Shaped solve of this by b.

Shaped solve of this by b.

Definition Classes
NumericOps
44. #### final def ^^[TT >: BitVector, B, That](b: B)(implicit op: operators.OpXor.Impl2[TT, B, That]): That

Alias for :^^(b) for all b.

Alias for :^^(b) for all b.

Definition Classes
NumericOps
45. #### final def ^^=[TT >: BitVector, B](b: B)(implicit op: operators.OpXor.InPlaceImpl2[TT, B]): BitVector

Mutates this by element-wise xor of this and b.

Mutates this by element-wise xor of this and b.

Definition Classes
NumericOps
46. #### def active: TensorActive[Int, Boolean, BitVector]

Definition Classes
TensorLike
47. #### def activeIterator: Iterator[(Int, Boolean)]

Definition Classes
BitVectorQuasiTensor
48. #### def activeKeysIterator: Iterator[Int]

Definition Classes
BitVectorQuasiTensor
49. #### def activeSize: Int

Definition Classes
BitVectorTensorLike
50. #### def activeValuesIterator: Iterator[Boolean]

This will just be a bunch of true values.

This will just be a bunch of true values.

Definition Classes
BitVectorQuasiTensor
51. #### def apply(i: Int): Boolean

Definition Classes
BitVectorTensorLikeQuasiTensor
52. #### def apply[Slice1, Slice2, Result](slice1: Slice1, slice2: Slice2)(implicit canSlice: CanSlice2[BitVector, Slice1, Slice2, Result]): Result

Method for slicing that is tuned for Matrices.

Method for slicing that is tuned for Matrices.

returns

Definition Classes
TensorLike
53. #### def apply[Result](a: Int, slice: Int*)(implicit canSlice: CanSlice[BitVector, Seq[Int], Result]): Result

Slice a sequence of elements.

Slice a sequence of elements. Must be at least 2.

Result
a
slice
canSlice
returns

Definition Classes
TensorLike
54. #### def apply[Slice, Result](slice: Slice)(implicit canSlice: CanSlice[BitVector, Slice, Result]): Result

method for slicing a tensor.

method for slicing a tensor. For instance, DenseVectors support efficient slicing by a Range object.

returns

Definition Classes
TensorLike
55. #### def argmax(implicit ord: Ordering[Boolean]): Int

Definition Classes
QuasiTensor
56. #### def argmin(implicit ord: Ordering[Boolean]): Int

Definition Classes
QuasiTensor
57. #### def argsort(implicit ord: Ordering[Boolean]): IndexedSeq[Int]

Definition Classes
QuasiTensor
58. #### def argtopk(k: Int)(implicit ordering: Ordering[Boolean]): IndexedSeq[Int]

Returns the k indices with maximum value.

Returns the k indices with maximum value. (NOT absolute value.)

k

how many to return

ordering
returns

Definition Classes
QuasiTensor
59. #### final def asInstanceOf[T0]: T0

Definition Classes
Any
60. #### def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
61. #### def copy: BitVector

Definition Classes
BitVectorVectorLike

63. #### final def dot[TT >: BitVector, B, BB >: B, That](b: B)(implicit op: operators.OpMulInner.Impl2[TT, BB, That]): That

Inner product of this and b.

Inner product of this and b.

Definition Classes
NumericOps

65. #### final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
66. #### def equals(p1: Any): Boolean

Definition Classes
Vector → AnyRef → Any
67. #### def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
68. #### def findAll(f: (Boolean) ⇒ Boolean): IndexedSeq[Int]

Returns all indices k whose value satisfies a predicate.

Returns all indices k whose value satisfies a predicate.

Definition Classes
QuasiTensor
69. #### def forall(fn: (Int, Boolean) ⇒ Boolean): Boolean

Returns true if and only if the given predicate is true for all elements.

Returns true if and only if the given predicate is true for all elements.

Definition Classes
TensorLike
70. #### def forallValues(fn: (Boolean) ⇒ Boolean): Boolean

Returns true if and only if the given predicate is true for all elements.

Returns true if and only if the given predicate is true for all elements.

Definition Classes
TensorLike
71. #### def foreach[U](fn: (Boolean) ⇒ U): Unit

Definition Classes
VectorLike
72. #### def foreachKey[U](fn: (Int) ⇒ U): Unit

Applies the given function to each key in the tensor.

Applies the given function to each key in the tensor.

Definition Classes
TensorLike
73. #### def foreachPair[U](fn: (Int, Boolean) ⇒ U): Unit

Applies the given function to each key and its corresponding value.

Applies the given function to each key and its corresponding value.

Definition Classes
TensorLike
74. #### def foreachValue[U](fn: (Boolean) ⇒ U): Unit

Applies the given function to each value in the map (one for each element of the domain, including zeros).

Applies the given function to each value in the map (one for each element of the domain, including zeros).

Definition Classes
TensorLike
75. #### final def getClass(): Class[_]

Definition Classes
AnyRef → Any
76. #### def hashCode(): Int

Definition Classes
AnyRef → Any
77. #### final def isInstanceOf[T0]: Boolean

Definition Classes
Any
78. #### def iterator: Iterator[(Int, Boolean)]

Definition Classes
VectorQuasiTensor
79. #### def keySet: Set[Int]

returns

the set of keys in this vector (0 until length)

Definition Classes
VectorQuasiTensor
80. #### def keys: TensorKeys[Int, Boolean, BitVector]

Definition Classes
TensorLike
81. #### def keysIterator: Iterator[Int]

Definition Classes
VectorQuasiTensor
82. #### val length: Int

Definition Classes
BitVectorVector

84. #### def map[E2, That](fn: (Boolean) ⇒ E2)(implicit canMapValues: CanMapValues[BitVector, Boolean, E2, That]): That

Definition Classes
VectorLike
85. #### def mapActivePairs[TT >: BitVector, O, That](f: (Int, Boolean) ⇒ O)(implicit bf: CanMapKeyValuePairs[TT, Int, Boolean, O, That]): That

Maps all active key-value pairs values.

Maps all active key-value pairs values.

Definition Classes
TensorLike
86. #### def mapActiveValues[TT >: BitVector, O, That](f: (Boolean) ⇒ O)(implicit bf: CanMapValues[TT, Boolean, O, That]): That

Maps all non-zero values.

Maps all non-zero values.

Definition Classes
TensorLike
87. #### def mapPairs[TT >: BitVector, O, That](f: (Int, Boolean) ⇒ O)(implicit bf: CanMapKeyValuePairs[TT, Int, Boolean, O, That]): That

Creates a new map containing a transformed copy of this map.

Creates a new map containing a transformed copy of this map.

Definition Classes
TensorLike
88. #### def mapValues[TT >: BitVector, O, That](f: (Boolean) ⇒ O)(implicit bf: CanMapValues[TT, Boolean, O, That]): That

Creates a new map containing a transformed copy of this map.

Creates a new map containing a transformed copy of this map.

Definition Classes
TensorLike
89. #### def max(implicit ord: Ordering[Boolean]): Boolean

Definition Classes
QuasiTensor
90. #### def min(implicit ord: Ordering[Boolean]): Boolean

Definition Classes
QuasiTensor
91. #### final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
92. #### final def norm[TT >: BitVector, B, R](b: B)(implicit op: norm.Impl2[TT, B, R]): R

Represents the norm of this vector

Represents the norm of this vector

Definition Classes
NumericOps
93. #### final def norm[TT >: BitVector, R]()(implicit op: norm.Impl[TT, R]): R

Represents the "natural" norm of this vector, for types that don't support arbitrary norms

Represents the "natural" norm of this vector, for types that don't support arbitrary norms

Definition Classes
NumericOps
94. #### final def notify(): Unit

Definition Classes
AnyRef
95. #### final def notifyAll(): Unit

Definition Classes
AnyRef
96. #### def pairs: TensorPairs[Int, Boolean, BitVector]

Definition Classes
TensorLike
97. #### def repr: BitVector

Definition Classes
BitVectorNumericOps
98. #### def size: Int

Definition Classes
VectorTensorLike
99. #### def sum(implicit num: Numeric[Boolean]): Boolean

Definition Classes
QuasiTensor
100. #### final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
101. #### final def t[TT >: BitVector, That, Slice1, Slice2, Result](a: Slice1, b: Slice2)(implicit op: CanTranspose[TT, That], canSlice: CanSlice2[That, Slice1, Slice2, Result]): Result

A transposed view of this object, followed by a slice.

A transposed view of this object, followed by a slice. Sadly frequently necessary.

Definition Classes
NumericOps
102. #### final def t[TT >: BitVector, That](implicit op: CanTranspose[TT, That]): That

A transposed view of this object.

A transposed view of this object.

Definition Classes
NumericOps
103. #### def toArray(implicit cm: ClassTag[Boolean]): Array[Boolean]

Definition Classes
Vector
104. #### def toDenseVector(implicit cm: ClassTag[Boolean]): DenseVector[Boolean]

Definition Classes
Vector
105. #### def toString(): String

Definition Classes
BitVector → AnyRef → Any
106. #### final def unary_![TT >: BitVector, That](implicit op: operators.OpNot.Impl[TT, That]): That

Definition Classes
NumericOps
107. #### final def unary_-[TT >: BitVector, That](implicit op: operators.OpNeg.Impl[TT, That]): That

Definition Classes
NumericOps
108. #### def update(i: Int, v: Boolean): Unit

Definition Classes
BitVectorTensorLikeQuasiTensor
109. #### def values: TensorValues[Int, Boolean, BitVector]

Definition Classes
TensorLike
110. #### def valuesIterator: Iterator[Boolean]

Definition Classes
VectorQuasiTensor
111. #### final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
112. #### final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
113. #### final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
114. #### final def |[TT >: BitVector, B, That](b: B)(implicit op: operators.OpOr.Impl2[TT, B, That]): That

Alias for :||(b) for all b.

Alias for :||(b) for all b.

Definition Classes
NumericOps
115. #### final def |=[TT >: BitVector, B](b: B)(implicit op: operators.OpOr.InPlaceImpl2[TT, B]): BitVector

Mutates this by element-wise or of this and b.

Mutates this by element-wise or of this and b.

Definition Classes
NumericOps

### Deprecated Value Members

1. #### def all(implicit semi: Semiring[Boolean]): Boolean

Returns true if all elements are non-zero

Returns true if all elements are non-zero

Definition Classes
QuasiTensor
Annotations
@deprecated
Deprecated

(Since version 0.6) Use breeze.linalg.all instead

2. #### def any(implicit semi: Semiring[Boolean]): Boolean

Returns true if some element is non-zero

Returns true if some element is non-zero

Definition Classes
QuasiTensor
Annotations
@deprecated
Deprecated

(Since version 0.6) Use breeze.linalg.any instead