is_valid: Board Validity Check
In lilinhonglexie/percolate: What the Package Does (One Line, Title Case)
Description
Usage
Arguments
Value
Examples
Description
Checks if a board matrix is valid. By definition, a valid board matrix is
a square matrix containing only 0, 1 and 2s. If the input is invalid, this
function throws an error, otherwise it returns TRUE.
Usage
1
is_valid(board_mat)
Arguments
board_mat
Board matrix to be checked.
Value
Either throws an error or returns TRUE
Examples
1
2
is_valid(generate_board_mat()) # should return TRUE
is_valid(generate_board_mat(n=1)) # should return TRUE
lilinhonglexie/percolate documentation built on Nov. 4, 2019, 4:32 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value Examples
Description
Checks if a board matrix is valid. By definition, a valid board matrix is a square matrix containing only 0, 1 and 2s. If the input is invalid, this function throws an error, otherwise it returns TRUE.
Usage
1 | is_valid(board_mat)
|
Arguments
board_mat |
Board matrix to be checked. |
Value
Either throws an error or returns TRUE
Examples
1 2 | is_valid(generate_board_mat()) # should return TRUE
is_valid(generate_board_mat(n=1)) # should return TRUE
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.