Function names changed

man/contourmvcd.Rd → man/contourmcd.Rd

 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/contourmvcd.R
-\name{contourmvcd}
-\alias{contourmvcd}
+\name{contourmcd}
+\alias{contourmcd}
 \title{Contour Plot of the Bivariate Cauchy Density}
 \usage{
-contourmvcd(mu, Sigma,
+contourmcd(mu, Sigma,
                    xlim = c(mu[1] + c(-10, 10)*Sigma[1, 1]),
                    ylim = c(mu[2] + c(-10, 10)*Sigma[2, 2]),
                    zlim = NULL, npt = 30, nx = npt, ny = npt,
@@ -29,7 +29,7 @@ contourmvcd(mu, Sigma,
 
 \item{nlevels, levels}{arguments to be passed to the \code{\link{contour}} function.}
 
-\item{tol}{tolerance (relative to largest variance) for numerical lack of positive-definiteness in Sigma, for the estimation of the density. see \code{\link{mvdcd}}.}
+\item{tol}{tolerance (relative to largest variance) for numerical lack of positive-definiteness in Sigma, for the estimation of the density. see \code{\link{dmcd}}.}
 
 \item{...}{additional arguments to \code{\link{plot.window}}, \code{\link{title}}, \code{\link{Axis}} and \code{\link{box}}, typically \link{graphical parameters} such as \code{cex.axis}.}
 }
@@ -43,7 +43,7 @@ with location parameter \code{mu} and scatter matrix \code{Sigma}.
 \examples{
 mu <- c(1, 4)
 Sigma <- matrix(c(0.8, 0.2, 0.2, 0.2), nrow = 2)
-contourmvcd(mu, Sigma)
+contourmcd(mu, Sigma)
 
 }
 \references{
@@ -52,9 +52,9 @@ Entropy, 24, 838, July 2022.
 \doi{10.3390/e24060838}
 }
 \seealso{
-\code{\link{mvdcd}}: probability density of a multivariate Cauchy density
+\code{\link{dmcd}}: probability density of a multivariate Cauchy density
 
-\code{\link{plotmvcd}}: 3D plot of a bivariate Cauchy density.
+\code{\link{plotmcd}}: 3D plot of a bivariate Cauchy density.
 }
 \author{
 Pierre Santagostini, Nizar Bouhlel

man/mvdcd.Rd → man/dmcd.Rd

 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/mvdcd.R
-\name{mvdcd}
-\alias{mvdcd}
+\name{dmcd}
+\alias{dmcd}
 \title{Density of a Multivariate Cauchy Distribution}
 \usage{
-mvdcd(x, mu, Sigma, tol = 1e-6)
+dmcd(x, mu, Sigma, tol = 1e-6)
 }
 \arguments{
 \item{x}{length \eqn{p} numeric vector.}
@@ -29,14 +29,14 @@ The density function of a multivariate Cauchy distribution is given by:
 \examples{
 mu <- c(0, 1, 4)
 sigma <- matrix(c(1, 0.6, 0.2, 0.6, 1, 0.3, 0.2, 0.3, 1), nrow = 3)
-mvdcd(c(0, 1, 4), mu, sigma)
-mvdcd(c(1, 2, 3), mu, sigma)
+dmcd(c(0, 1, 4), mu, sigma)
+dmcd(c(1, 2, 3), mu, sigma)
 
 }
 \seealso{
-\code{\link{mvrcd}}: random generation from a MCD.
+\code{\link{rmcd}}: random generation from a MCD.
 
-\code{\link{plotmvcd}}, \code{\link{contourmvcd}}: plot of a bivariate Cauchy density.
+\code{\link{plotmcd}}, \code{\link{contourmcd}}: plot of a bivariate Cauchy density.
 }
 \author{
 Pierre Santagostini, Nizar Bouhlel

man/plotmvcd.Rd → man/plotmcd.Rd

 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/plotmvcd.R
-\name{plotmvcd}
-\alias{plotmvcd}
+\name{plotmcd}
+\alias{plotmcd}
 \title{Plot of the Bivariate Cauchy Density}
 \usage{
-plotmvcd(mu, Sigma, xlim = c(mu[1] + c(-10, 10)*Sigma[1, 1]),
+plotmcd(mu, Sigma, xlim = c(mu[1] + c(-10, 10)*Sigma[1, 1]),
                 ylim = c(mu[2] + c(-10, 10)*Sigma[2, 2]), n = 101,
                 xvals = NULL, yvals = NULL, xlab = "x", ylab = "y",
                 zlab = "f(x,y)", col = "gray", tol = 1e-6, ...)
@@ -24,7 +24,7 @@ plotmvcd(mu, Sigma, xlim = c(mu[1] + c(-10, 10)*Sigma[1, 1]),
 
 \item{col}{The color to use for the plot. See \code{\link{plot3d.function}}.}
 
-\item{tol}{tolerance (relative to largest variance) for numerical lack of positive-definiteness in Sigma, for the estimation of the density. see \code{\link{mvdcd}}.}
+\item{tol}{tolerance (relative to largest variance) for numerical lack of positive-definiteness in Sigma, for the estimation of the density. see \code{\link{dmcd}}.}
 
 \item{...}{Additional arguments to pass to \code{\link{plot3d.function}}.}
 }
@@ -38,7 +38,7 @@ with location parameter \code{mu} and scatter matrix \code{Sigma}.
 \examples{
 mu <- c(1, 4)
 Sigma <- matrix(c(0.8, 0.2, 0.2, 0.2), nrow = 2)
-plotmvcd(mu, Sigma)
+plotmcd(mu, Sigma)
 
 }
 \references{
@@ -47,9 +47,9 @@ Entropy, 24, 838, July 2022.
 \doi{10.3390/e24060838}
 }
 \seealso{
-\code{\link{mvdcd}}: probability density of a multivariate Cauchy density
+\code{\link{dmcd}}: probability density of a multivariate Cauchy density
 
-\code{\link{contourmvcd}}: contour plot of a bivariate Cauchy density.
+\code{\link{contourmcd}}: contour plot of a bivariate Cauchy density.
 
 \code{\link{plot3d.function}}: plot a function of two variables.
 }

man/mvrcd.Rd → man/rmcd.Rd

 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/mvrcd.R
-\name{mvrcd}
-\alias{mvrcd}
+\name{rmcd}
+\alias{rmcd}
 \title{Simulate from a Multivariate Cauchy Distribution}
 \usage{
-mvrcd(n, mu, Sigma, tol = 1e-6)
+rmcd(n, mu, Sigma, tol = 1e-6)
 }
 \arguments{
 \item{n}{integer. Number of observations.}
@@ -33,13 +33,13 @@ and \eqn{u} is distributed among a Chi-squared distribution with 1 degree of fre
 \examples{
 mu <- c(0, 1, 4)
 sigma <- matrix(c(1, 0.6, 0.2, 0.6, 1, 0.3, 0.2, 0.3, 1), nrow = 3)
-x <- mvrcd(100, mu, sigma)
+x <- rmcd(100, mu, sigma)
 x
 apply(x, 2, median)
 
 }
 \seealso{
-\code{\link{mvdcd}}: probability density of a MCD.
+\code{\link{dmcd}}: probability density of a MCD.
 }
 \author{
 Pierre Santagostini, Nizar Bouhlel