R/method_gcd.R

In polyMatrix: Infrastructure for Manipulation Polynomial Matrices

# Title     : Greater common divisor of a matrix
# Created by: namezys
# Created on: 2021. 05. 09.

#' GCD for polynomial matrices
#'
#' The greatest common divisor of polynomials or polynomial matrices.
#'
#' @param ... a list of polynomial objects
#' @seealso polynomial implementation [polynom::GCD()] and [LCM()]
#'
#' @export
setGeneric("GCD", polynom::GCD)
#' @describeIn GCD the greatest common divisor of all elements of the polynomial matrix
#'
#' @examples
#'
#' # GCD of polynomial matrix
#'
#' GCD(parse.polyMatrix(
#'  "  1 - x, 1 - x^2, 1 + 2*x + x^2",
#'  "x - x^2,   1 + x, 1 - 2*x + x^2"
#' ))  ## 1
#'
#' @export
setMethod("GCD", signature(...=PM), function (...) { polynom::GCD(.as.list.polyMatrix(...)) })