From 4ff0472aefcc99d0eaa844bde4994b35d6ddf502 Mon Sep 17 00:00:00 2001 From: stla Date: Tue, 26 Mar 2024 14:21:39 +0100 Subject: [PATCH] doc --- DESCRIPTION | 13 +++++++------ R/braids.R | 16 ++++++++-------- man/allBraidWords.Rd | 2 +- man/allPositiveBraidWords.Rd | 2 +- man/doubleSigma.Rd | 8 ++++---- man/halfTwist.Rd | 2 +- man/tau.Rd | 2 +- 7 files changed, 23 insertions(+), 22 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index fc114bf..1406ab6 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,16 +1,17 @@ Package: braids Title: The Braid Groups -Version: 0.0.0.9000 -Authors@R: - c( +Version: 1.0.0 +Authors@R: c( person("Stéphane", "Laurent", , "laurent_step@outlook.fr", role = c("aut", "cre")), - person("Balazs", "Komuves", role = "cph", comment = "author of the Haskell library 'combinat'") + person("Balazs", "Komuves", role = "cph", + comment = "author of the Haskell library 'combinat'") ) Description: Deals with the braid groups. Includes creation of some specific braids, group operations, free reduction, and Bronfman polynomials. Braid theory has applications in fluid mechanics and - quantum physics. The code is adapted from the 'Haskell' library 'combinat', - and is based on Birman and Brendle (2005) . + quantum physics. The code is adapted from the 'Haskell' library + 'combinat', and is based on Birman and Brendle (2005) + . License: GPL-3 URL: https://github.com/stla/braids BugReports: https://github.com/stla/braids/issues diff --git a/R/braids.R b/R/braids.R index 977839a..b147ce7 100644 --- a/R/braids.R +++ b/R/braids.R @@ -171,11 +171,11 @@ braidPermutation <- function(braid) { } #' @title Double generator -#' @description Generator \code{sigma_{s,t}} in the Birman-Ko-Lee new -#' presentation. It twistes the strands \code{s} and \code{t} whie going over -#' all other strands (for \code{t=s+1}, this is \code{sigma_s}). +#' @description Generator \eqn{\sigma_{s,t}} in the Birman-Ko-Lee new +#' presentation. It twists the strands \code{s} and \code{t} while going over +#' all other strands (for \code{t=s+1}, this is \eqn{\sigma_s}). #' -#' @param n number of strands, integer \code{>= 2} +#' @param n number of strands, integer \code{>=2} #' @param s,t indices of two strands, \code{s < t} #' #' @return A \code{braid} object. @@ -207,7 +207,7 @@ doubleSigma <- function(n, s, t) { #' @description The (positive) half-twist of all the braid strands, usually #' denoted by \eqn{\Delta}. #' -#' @param n number of strands, integer \code{>= 2} +#' @param n number of strands, integer \code{>=2} #' #' @return A \code{braid} object. #' @export @@ -230,7 +230,7 @@ halfTwist <- function(n) { #' @title Inner automorphism #' @description The inner automorphism defined by #' \eqn{\tau X = \Delta^{-1} X \Delta}, where \eqn{\Delta} is the -#' positive half-twist; it send each generator \eqn{\sigma_j} to +#' positive half-twist; it sends each generator \eqn{\sigma_j} to #' \eqn{\sigma_{n-j}}. #' #' @param braid a \code{braid} object @@ -523,7 +523,7 @@ permutationBraid <- function(perm) { #' @title Positive braid words of given length #' @description All positive braid words of the given length. #' -#' @param n number of strands, positive integer \code{>= 2} +#' @param n number of strands, integer \code{>=2} #' @param l length of the words #' #' @return A list of \code{braid} objects. @@ -559,7 +559,7 @@ allPositiveBraidWords <- function(n, l) { #' @title Braid words of given length #' @description All braid words of the given length. #' -#' @param n number of strands, positive integer \code{>= 2} +#' @param n number of strands, integer \code{>=2} #' @param l length of the words #' #' @return A list of \code{braid} objects. diff --git a/man/allBraidWords.Rd b/man/allBraidWords.Rd index 175f9b7..6d68c19 100644 --- a/man/allBraidWords.Rd +++ b/man/allBraidWords.Rd @@ -7,7 +7,7 @@ allBraidWords(n, l) } \arguments{ -\item{n}{number of strands, positive integer \code{>= 2}} +\item{n}{number of strands, integer \code{>=2}} \item{l}{length of the words} } diff --git a/man/allPositiveBraidWords.Rd b/man/allPositiveBraidWords.Rd index 67580c0..bb93c04 100644 --- a/man/allPositiveBraidWords.Rd +++ b/man/allPositiveBraidWords.Rd @@ -7,7 +7,7 @@ allPositiveBraidWords(n, l) } \arguments{ -\item{n}{number of strands, positive integer \code{>= 2}} +\item{n}{number of strands, integer \code{>=2}} \item{l}{length of the words} } diff --git a/man/doubleSigma.Rd b/man/doubleSigma.Rd index abe8031..55e72ab 100644 --- a/man/doubleSigma.Rd +++ b/man/doubleSigma.Rd @@ -7,7 +7,7 @@ doubleSigma(n, s, t) } \arguments{ -\item{n}{number of strands, integer \code{>= 2}} +\item{n}{number of strands, integer \code{>=2}} \item{s, t}{indices of two strands, \code{s < t}} } @@ -15,9 +15,9 @@ doubleSigma(n, s, t) A \code{braid} object. } \description{ -Generator \code{sigma_{s,t}} in the Birman-Ko-Lee new - presentation. It twistes the strands \code{s} and \code{t} whie going over - all other strands (for \code{t=s+1}, this is \code{sigma_s}). +Generator \eqn{\sigma_{s,t}} in the Birman-Ko-Lee new + presentation. It twists the strands \code{s} and \code{t} while going over + all other strands (for \code{t=s+1}, this is \eqn{\sigma_s}). } \examples{ doubleSigma(5, 1, 3) diff --git a/man/halfTwist.Rd b/man/halfTwist.Rd index 87b0be9..4693dc0 100644 --- a/man/halfTwist.Rd +++ b/man/halfTwist.Rd @@ -7,7 +7,7 @@ halfTwist(n) } \arguments{ -\item{n}{number of strands, integer \code{>= 2}} +\item{n}{number of strands, integer \code{>=2}} } \value{ A \code{braid} object. diff --git a/man/tau.Rd b/man/tau.Rd index 9249e2f..e12d70c 100644 --- a/man/tau.Rd +++ b/man/tau.Rd @@ -15,7 +15,7 @@ A \code{braid} object. \description{ The inner automorphism defined by \eqn{\tau X = \Delta^{-1} X \Delta}, where \eqn{\Delta} is the - positive half-twist; it send each generator \eqn{\sigma_j} to + positive half-twist; it sends each generator \eqn{\sigma_j} to \eqn{\sigma_{n-j}}. } \examples{