R Package to check wether the roots of any given polynomial lie outside the unit circle.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
R
man
.Rbuildignore
.gitignore
DESCRIPTION
NAMESPACE
README.Rmd
README.md
unitcircle.Rproj

README.md

The UnitCircle Package

As of now this package only containts the uc.check function wich checks whether the roots of a given polynomial lie outside the Unit circle.

Usage

The function uc.check has the following Arguments:

Argument Description
pol_ A vector of polynomial coefficients in increasing order.
plot_output Logical that defines whether a graphical output should be created.
print_output Logical that defines whether to print the results.

Examples:

library(UnitCircle)
uc.check(pol_ = c(1,0,0.99999), plot_output = FALSE)
#>   real   complex outside
#> 1    0  1.000005    TRUE
#> 2    0 -1.000005    TRUE
#> *Results are rounded to 6 digits.
uc.check(pol_ = c(2,0,2.2,-3), plot_output = TRUE)
#>        real   complex outside
#> 1 -0.232289  0.708919   FALSE
#> 2 -0.232289 -0.708919   FALSE
#> 3  1.197912  0.000000    TRUE
#> *Results are rounded to 6 digits.

Installation

Install from CRAN

You can install the official Version from CRAN:

install.packages("UnitCircle")

Install from Github

You can install the latest development version from github with

# install.packages("devtools")
devtools::install_github("BerriJ/UnitCircle")

License

  • UnitCircle is licensed under GPL-3