R/exports-matrices.R

In assertive: Readable Check Functions to Ensure Code Integrity

# From assertive.matrices is-matrix.R, assert-is-matrix.R

#' Is the input a diagonal matrix?
#' 
#' See \code{\link[assertive.matrices]{is_diagonal_matrix}}.
#' @name is_diagonal_matrix
#' @aliases assert_is_diagonal_matrix
#' @export is_diagonal_matrix
#' @export assert_is_diagonal_matrix
NULL 

#' Is the input an identity matrix?
#' 
#' See \code{\link[assertive.matrices]{is_identity_matrix}}.
#' @name is_identity_matrix
#' @aliases assert_is_identity_matrix
#' @export is_identity_matrix
#' @export assert_is_identity_matrix
NULL 


#' Is the matrix upper/lower triangular?
#' 
#' See \code{\link[assertive.matrices]{is_lower_triangular_matrix}}.
#' @name is_lower_triangular_matrix
#' @aliases is_upper_triangular_matrix assert_is_lower_triangular_matrix assert_is_upper_triangular_matrix
#' @export is_lower_triangular_matrix
#' @export is_upper_triangular_matrix
#' @export assert_is_lower_triangular_matrix
#' @export assert_is_upper_triangular_matrix
NULL 

#' Is the input a square matrix?
#' 
#' See \code{\link[assertive.matrices]{is_square_matrix}}.
#' @name is_square_matrix
#' @aliases assert_is_square_matrix
#' @export is_square_matrix
#' @export assert_is_square_matrix
NULL

#' Is the input a symmetric matrix?
#' 
#' See \code{\link[assertive.matrices]{is_symmetric_matrix}}.
#' @name is_symmetric_matrix
#' @aliases assert_is_symmetric_matrix
#' @export is_symmetric_matrix
#' @export assert_is_symmetric_matrix
NULL

#' Is the input a zero matrix?
#' 
#' See \code{\link[assertive.matrices]{is_zero_matrix}}.
#' @name is_zero_matrix
#' @aliases assert_is_zero_matrix
#' @export is_zero_matrix
#' @export assert_is_zero_matrix
NULL