BooleanMatrix (abacus API Documentation)

java.lang.Object
- com.landawn.abacus.util.AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
- - com.landawn.abacus.util.BooleanMatrix

public final class BooleanMatrix
extends AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>

Since:: 0.8
Author:: Haiyang Li

Field Summary
- Fields inherited from class com.landawn.abacus.util.AbstractMatrix
  cols, count, rows

Constructor Summary

Constructors
Constructor and Description

BooleanMatrix(boolean[][] a)

Constructors
Constructor and Description
`BooleanMatrix(boolean[][] a)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Stream<Pair.IntPair>`	`adjacent4Points(int i, int j)` Returns the four adjacencies with order: up, right, down, left.
`Stream<Pair.IntPair>`	`adjacent8Points(int i, int j)` Returns the eight adjacencies with order: left-up, up, right-up, right, right-down, down, left-down, left.
`boolean[][]`	`array()`
`Matrix<java.lang.Boolean>`	`boxed()`
`boolean[]`	`column(int columnIndex)`
`BooleanMatrix`	`copy()`
`BooleanMatrix`	`copy(int fromRowIndex, int toRowIndex)`
`BooleanMatrix`	`copy(int fromRowIndex, int toRowIndex, int fromColumnIndex, int toColumnIndex)`
`static BooleanMatrix`	`diagonal(boolean[] leftUp2RighDownDiagonal, boolean[] rightUp2LeftDownDiagonal)`
`static BooleanMatrix`	`diagonalLU2RD(boolean[] leftUp2RighDownDiagonal)`
`static BooleanMatrix`	`diagonalRU2LD(boolean[] rightUp2LeftDownDiagonal)`
`OptionalBoolean`	`downOf(int i, int j)`
`static BooleanMatrix`	`empty()`
`boolean`	`equals(java.lang.Object obj)`
`void`	`fill(boolean val)`
`void`	`fill(boolean[][] b)`
`void`	`fill(int fromRowIndex, int fromColumnIndex, boolean[][] b)`
`BooleanList`	`flatten()`
`BooleanMatrix`	`flipH()`
`BooleanMatrix`	`flipV()`
`void`	`forEach(BooleanConsumer action)`
`void`	`forEach(int fromRowIndex, int toRowIndex, int fromColumnIndex, int toColumnIndex, BooleanConsumer action)`
`boolean`	`get(int i, int j)`
`boolean`	`get(Pair.IntPair point)`
`boolean[]`	`getLU2RD()`
`boolean[]`	`getRU2LD()`
`int`	`hashCode()`
`BooleanMatrix`	`hstack(BooleanMatrix b)`
`OptionalBoolean`	`leftOf(int i, int j)`
`BooleanMatrix`	`map(BooleanUnaryOperator func)`
`<T> Matrix<T>`	`mapToObj(java.lang.Class<T> cls, BooleanFunction<? extends T> func)`
`static BooleanMatrix`	`of(boolean[]... a)`
`static BooleanMatrix`	`random(int len)`
`static BooleanMatrix`	`repeat(boolean val, int len)`
`BooleanMatrix`	`repelem(int rowRepeats, int colRepeats)` Repeat elements `rowRepeats` times in row direction and `colRepeats` times in column direction.
`void`	`replaceIf(BooleanPredicate predicate, boolean newValue)`
`void`	`replaceIf(IntBiPredicate predicate, boolean newValue)` Replace elements by `Predicate.test(i, j)` based on points
`BooleanMatrix`	`repmat(int rowRepeats, int colRepeats)` Repeat this matrix `rowRepeats` times in row direction and `colRepeats` times in column direction.
`BooleanMatrix`	`reshape(int newRows, int newCols)`
`void`	`reverseH()`
`void`	`reverseV()`
`OptionalBoolean`	`rightOf(int i, int j)`
`BooleanMatrix`	`rotate180()` Rotate this matrix clockwise 180
`BooleanMatrix`	`rotate270()` Rotate this matrix clockwise 270
`BooleanMatrix`	`rotate90()` Rotate this matrix clockwise 90
`boolean[]`	`row(int rowIndex)`
`void`	`set(int i, int j, boolean val)`
`void`	`set(Pair.IntPair point, boolean val)`
`void`	`setColumn(int columnIndex, boolean[] column)`
`void`	`setLU2RD(boolean[] diagonal)`
`void`	`setRow(int rowIndex, boolean[] row)`
`void`	`setRU2LD(boolean[] diagonal)`
`Stream<Stream<java.lang.Boolean>>`	`streamC()`
`Stream<Stream<java.lang.Boolean>>`	`streamC(int fromColumnIndex, int toColumnIndex)`
`Stream<java.lang.Boolean>`	`streamH()`
`Stream<java.lang.Boolean>`	`streamH(int rowIndex)`
`Stream<java.lang.Boolean>`	`streamH(int fromRowIndex, int toRowIndex)`
`Stream<java.lang.Boolean>`	`streamLU2RD()`
`Stream<Stream<java.lang.Boolean>>`	`streamR()`
`Stream<Stream<java.lang.Boolean>>`	`streamR(int fromRowIndex, int toRowIndex)`
`Stream<java.lang.Boolean>`	`streamRU2LD()`
`Stream<java.lang.Boolean>`	`streamV()`
`Stream<java.lang.Boolean>`	`streamV(int columnIndex)`
`Stream<java.lang.Boolean>`	`streamV(int fromColumnIndex, int toColumnIndex)`
`java.lang.String`	`toString()`
`BooleanMatrix`	`transpose()`
`void`	`updateAll(BooleanUnaryOperator func)`
`void`	`updateAll(IntBiFunction<java.lang.Boolean> func)` Update all elements based on points
`void`	`updateColumn(int columnIndex, BooleanUnaryOperator func)`
`void`	`updateLU2RD(BooleanUnaryOperator func)`
`void`	`updateRow(int rowIndex, BooleanUnaryOperator func)`
`void`	`updateRU2LD(BooleanUnaryOperator func)`
`OptionalBoolean`	`upOf(int i, int j)`
`BooleanMatrix`	`vstack(BooleanMatrix b)`
`BooleanMatrix`	`zipWith(BooleanMatrix matrixB, BooleanBiFunction<java.lang.Boolean> zipFunction)`
`BooleanMatrix`	`zipWith(BooleanMatrix matrixB, BooleanMatrix matrixC, BooleanTriFunction<java.lang.Boolean> zipFunction)`

Methods inherited from class com.landawn.abacus.util.AbstractMatrix
isEmpty, isSameShape, pointsC, pointsC, pointsH, pointsH, pointsH, pointsLU2RD, pointsR, pointsR, pointsRU2LD, pointsV, pointsV, pointsV, println, reshape

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BooleanMatrix
```
public BooleanMatrix(boolean[][] a)
```
- Method Detail
  - empty
```
public static BooleanMatrix empty()
```
  - of
```
@SafeVarargs
public static BooleanMatrix of(boolean[]... a)
```
  - random
```
public static BooleanMatrix random(int len)
```
  - repeat
```
public static BooleanMatrix repeat(boolean val,
                                   int len)
```
  - diagonalLU2RD
```
public static BooleanMatrix diagonalLU2RD(boolean[] leftUp2RighDownDiagonal)
```
  - diagonalRU2LD
```
public static BooleanMatrix diagonalRU2LD(boolean[] rightUp2LeftDownDiagonal)
```
  - diagonal
```
public static BooleanMatrix diagonal(boolean[] leftUp2RighDownDiagonal,
                                     boolean[] rightUp2LeftDownDiagonal)
```
  - array
```
public boolean[][] array()
```
  - get
```
public boolean get(int i,
                   int j)
```
  - get
```
public boolean get(Pair.IntPair point)
```
  - set
```
public void set(int i,
                int j,
                boolean val)
```
  - set
```
public void set(Pair.IntPair point,
                boolean val)
```
  - upOf
```
public OptionalBoolean upOf(int i,
                            int j)
```
  - downOf
```
public OptionalBoolean downOf(int i,
                              int j)
```
  - leftOf
```
public OptionalBoolean leftOf(int i,
                              int j)
```
  - rightOf
```
public OptionalBoolean rightOf(int i,
                               int j)
```
  - adjacent4Points
```
public Stream<Pair.IntPair> adjacent4Points(int i,
                                            int j)
```
    Returns the four adjacencies with order: up, right, down, left. null is set if the adjacency doesn't exist.
    
    Parameters:
    
    i -
    
    j -
    
    Returns:
  - adjacent8Points
```
public Stream<Pair.IntPair> adjacent8Points(int i,
                                            int j)
```
    Returns the eight adjacencies with order: left-up, up, right-up, right, right-down, down, left-down, left. null is set if the adjacency doesn't exist.
    
    Parameters:
    
    i -
    
    j -
    
    Returns:
  - row
```
public boolean[] row(int rowIndex)
```
  - column
```
public boolean[] column(int columnIndex)
```
  - setRow
```
public void setRow(int rowIndex,
                   boolean[] row)
```
  - setColumn
```
public void setColumn(int columnIndex,
                      boolean[] column)
```
  - updateRow
```
public void updateRow(int rowIndex,
                      BooleanUnaryOperator func)
```
  - updateColumn
```
public void updateColumn(int columnIndex,
                         BooleanUnaryOperator func)
```
  - getLU2RD
```
public boolean[] getLU2RD()
```
  - setLU2RD
```
public void setLU2RD(boolean[] diagonal)
```
  - updateLU2RD
```
public void updateLU2RD(BooleanUnaryOperator func)
```
  - getRU2LD
```
public boolean[] getRU2LD()
```
  - setRU2LD
```
public void setRU2LD(boolean[] diagonal)
```
  - updateRU2LD
```
public void updateRU2LD(BooleanUnaryOperator func)
```
  - updateAll
```
public void updateAll(BooleanUnaryOperator func)
```
  - updateAll
```
public void updateAll(IntBiFunction<java.lang.Boolean> func)
```
    Update all elements based on points
    
    Parameters:
    
    func -
  - replaceIf
```
public void replaceIf(BooleanPredicate predicate,
                      boolean newValue)
```
  - replaceIf
```
public void replaceIf(IntBiPredicate predicate,
                      boolean newValue)
```
    Replace elements by Predicate.test(i, j) based on points
    
    Parameters:
    
    predicate -
    
    newValue -
  - map
```
public BooleanMatrix map(BooleanUnaryOperator func)
```
  - mapToObj
```
public <T> Matrix<T> mapToObj(java.lang.Class<T> cls,
                              BooleanFunction<? extends T> func)
```
  - fill
```
public void fill(boolean val)
```
  - fill
```
public void fill(boolean[][] b)
```
  - fill
```
public void fill(int fromRowIndex,
                 int fromColumnIndex,
                 boolean[][] b)
```
  - copy
```
public BooleanMatrix copy()
```
    Specified by:
    
    copy in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Returns:
    
    a new Matrix
  - copy
```
public BooleanMatrix copy(int fromRowIndex,
                          int toRowIndex)
```
    Specified by:
    
    copy in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Returns:
    
    a new Matrix
  - copy
```
public BooleanMatrix copy(int fromRowIndex,
                          int toRowIndex,
                          int fromColumnIndex,
                          int toColumnIndex)
```
    Specified by:
    
    copy in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Returns:
    
    a new Matrix
  - reverseH
```
public void reverseH()
```
  - reverseV
```
public void reverseV()
```
  - flipH
```
public BooleanMatrix flipH()
```
  - flipV
```
public BooleanMatrix flipV()
```
  - rotate90
```
public BooleanMatrix rotate90()
```
    Description copied from class: AbstractMatrix
    
    Rotate this matrix clockwise 90
    
    Specified by:
    
    rotate90 in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Returns:
    
    a new Matrix
  - rotate180
```
public BooleanMatrix rotate180()
```
    Description copied from class: AbstractMatrix
    
    Rotate this matrix clockwise 180
    
    Specified by:
    
    rotate180 in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Returns:
    
    a new Matrix
  - rotate270
```
public BooleanMatrix rotate270()
```
    Description copied from class: AbstractMatrix
    
    Rotate this matrix clockwise 270
    
    Specified by:
    
    rotate270 in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Returns:
    
    a new Matrix
  - transpose
```
public BooleanMatrix transpose()
```
    Specified by:
    
    transpose in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
  - reshape
```
public BooleanMatrix reshape(int newRows,
                             int newCols)
```
    Specified by:
    
    reshape in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
  - repelem
```
public BooleanMatrix repelem(int rowRepeats,
                             int colRepeats)
```
    Repeat elements rowRepeats times in row direction and colRepeats times in column direction.
    
    Specified by:
    
    repelem in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Parameters:
    
    rowRepeats -
    
    colRepeats -
    
    Returns:
    
    a new matrix
  - repmat
```
public BooleanMatrix repmat(int rowRepeats,
                            int colRepeats)
```
    Repeat this matrix rowRepeats times in row direction and colRepeats times in column direction.
    
    Specified by:
    
    repmat in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Parameters:
    
    rowRepeats -
    
    colRepeats -
    
    Returns:
    
    a new matrix
  - flatten
```
public BooleanList flatten()
```
    Specified by:
    
    flatten in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
  - vstack
```
public BooleanMatrix vstack(BooleanMatrix b)
```
    Parameters:
    
    b -
    
    Returns:
    
    See Also:
    
    IntMatrix.vstack(IntMatrix)
  - hstack
```
public BooleanMatrix hstack(BooleanMatrix b)
```
    Parameters:
    
    b -
    
    Returns:
    
    See Also:
    
    IntMatrix.hstack(IntMatrix)
  - boxed
```
public Matrix<java.lang.Boolean> boxed()
```
  - zipWith
```
public BooleanMatrix zipWith(BooleanMatrix matrixB,
                             BooleanBiFunction<java.lang.Boolean> zipFunction)
```
  - zipWith
```
public BooleanMatrix zipWith(BooleanMatrix matrixB,
                             BooleanMatrix matrixC,
                             BooleanTriFunction<java.lang.Boolean> zipFunction)
```
  - streamLU2RD
```
public Stream<java.lang.Boolean> streamLU2RD()
```
    Specified by:
    
    streamLU2RD in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Returns:
    
    a stream composed by elements on the diagonal line from left up to right down.
  - streamRU2LD
```
public Stream<java.lang.Boolean> streamRU2LD()
```
    Specified by:
    
    streamRU2LD in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Returns:
    
    a stream composed by elements on the diagonal line from right up to left down.
  - streamH
```
public Stream<java.lang.Boolean> streamH()
```
    Specified by:
    
    streamH in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Returns:
    
    a stream based on the order of row.
  - streamH
```
public Stream<java.lang.Boolean> streamH(int rowIndex)
```
    Specified by:
    
    streamH in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
  - streamH
```
public Stream<java.lang.Boolean> streamH(int fromRowIndex,
                                         int toRowIndex)
```
    Specified by:
    
    streamH in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Parameters:
    
    fromRowIndex -
    
    toRowIndex -
    
    Returns:
    
    a stream based on the order of row.
  - streamV
```
@Beta
public Stream<java.lang.Boolean> streamV()
```
    Specified by:
    
    streamV in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Returns:
    
    a stream based on the order of column.
  - streamV
```
public Stream<java.lang.Boolean> streamV(int columnIndex)
```
    Specified by:
    
    streamV in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
  - streamV
```
@Beta
public Stream<java.lang.Boolean> streamV(int fromColumnIndex,
                                                int toColumnIndex)
```
    Specified by:
    
    streamV in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Parameters:
    
    fromColumnIndex -
    
    toColumnIndex -
    
    Returns:
    
    a stream based on the order of column.
  - streamR
```
public Stream<Stream<java.lang.Boolean>> streamR()
```
    Specified by:
    
    streamR in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Returns:
    
    a row stream based on the order of row.
  - streamR
```
public Stream<Stream<java.lang.Boolean>> streamR(int fromRowIndex,
                                                 int toRowIndex)
```
    Specified by:
    
    streamR in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Parameters:
    
    fromRowIndex -
    
    toRowIndex -
    
    Returns:
    
    a row stream based on the order of row.
  - streamC
```
@Beta
public Stream<Stream<java.lang.Boolean>> streamC()
```
    Specified by:
    
    streamC in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Returns:
    
    a column stream based on the order of column.
  - streamC
```
@Beta
public Stream<Stream<java.lang.Boolean>> streamC(int fromColumnIndex,
                                                        int toColumnIndex)
```
    Specified by:
    
    streamC in class AbstractMatrix<boolean[],BooleanList,Stream<java.lang.Boolean>,Stream<Stream<java.lang.Boolean>>,BooleanMatrix>
    
    Parameters:
    
    fromColumnIndex -
    
    toColumnIndex -
    
    Returns:
    
    a column stream based on the order of column.
  - forEach
```
public void forEach(BooleanConsumer action)
```
  - forEach
```
public void forEach(int fromRowIndex,
                    int toRowIndex,
                    int fromColumnIndex,
                    int toColumnIndex,
                    BooleanConsumer action)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class BooleanMatrix

Field Summary

Fields inherited from class com.landawn.abacus.util.AbstractMatrix

Constructor Summary

Method Summary

Methods inherited from class com.landawn.abacus.util.AbstractMatrix

Methods inherited from class java.lang.Object

Constructor Detail

BooleanMatrix

Method Detail

empty

of

random

repeat

diagonalLU2RD

diagonalRU2LD

diagonal

array

get

get

set

set

upOf

downOf

leftOf

rightOf

adjacent4Points

adjacent8Points

row

column

setRow

setColumn

updateRow

updateColumn

getLU2RD

setLU2RD

updateLU2RD

getRU2LD

setRU2LD

updateRU2LD

updateAll

updateAll

replaceIf

replaceIf

map

mapToObj

fill

fill

fill

copy

copy

copy

reverseH

reverseV

flipH

flipV

rotate90

rotate180

rotate270

transpose

reshape

repelem

repmat

flatten

vstack

hstack

boxed

zipWith

zipWith

streamLU2RD

streamRU2LD

streamH

streamH

streamH

streamV

streamV

streamV

streamR

streamR

streamC