R/jordbloc.R

In gallery: Generate Test Matrices for Numerical Experiments

#' @importFrom pracma Diag

# jordbloc: Jordan block matrix -------------------------------------------
#'
#' @name jordbloc
#' @title Create Jordan block matrix
#'
#' @description Returns a \code{n}-by-\code{n} Jordan block with eigenvalue
#'   \code{lambda}. The default is 1.
#'
#' @param n order of matrix
#' @param lambda eigenvalue of Jordan block
#'
#' @return Jordan block matrix
#'
#' @export
jordbloc <- function(n, lambda = 1){
  J <- lambda * diag(n) + Diag(rep(1, n-1), 1)
  return(J)
}