From 43c13bd4d3f7b78bd6c1546379cbcfd9b3dbeadc Mon Sep 17 00:00:00 2001 From: conrad Date: Fri, 19 May 2023 16:44:19 +1000 Subject: [PATCH] add docs for norm2est() and vecnorm() --- docs.html | 156 +++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 136 insertions(+), 20 deletions(-) diff --git a/docs.html b/docs.html index c82bd900..b5a60296 100644 --- a/docs.html +++ b/docs.html @@ -150,7 +150,7 @@ hr.greyline [top] -API Documentation for Armadillo 12.2 +API Documentation for Armadillo 12.4


@@ -413,37 +413,39 @@ Conrad Sanderson and Ryan Curtin. min / max return extremum values nonzeros return non-zero values norm various norms of vectors and matrices -normalise normalise vectors to unit p-norm +norm2est fast estimate of the matrix 2-norm +normalise normalise vectors to unit p-norm pow element-wise power powmat matrix power -prod product of elements +prod product of elements rank rank of matrix rcond reciprocal condition number -repelem replicate elements +repelem replicate elements repmat replicate matrix in block-like fashion reshape change size while keeping elements -resize change size while keeping elements and preserving layout +resize change size while keeping elements and preserving layout reverse reverse order of elements roots roots of polynomial -shift shift elements +shift shift elements shuffle randomly shuffle elements size obtain dimensions of given object -sort sort elements +sort sort elements sort_index vector describing sorted order of elements sqrtmat square root of matrix -sqrtmat_sympd square root of symmetric matrix +sqrtmat_sympd square root of symmetric matrix sum sum of elements sub2ind convert subscripts to linear index -symmatu / symmatl generate symmetric matrix from given matrix +symmatu / symmatl generate symmetric matrix from given matrix trace sum of diagonal elements trans transpose of matrix -trapz trapezoidal numerical integration +trapz trapezoidal numerical integration trimatu / trimatl copy upper/lower triangular part trimatu_ind / trimatl_ind obtain indices of upper/lower triangular part -unique return unique elements +unique return unique elements +vecnorm obtain vector norm of each row or column of a matrix vectorise flatten matrix into vector -misc functions miscellaneous element-wise functions: exp, log, sqrt, round, sign, ... -trig functions trigonometric element-wise functions: cos, sin, tan, ... +misc functions miscellaneous element-wise functions: exp, log, sqrt, round, sign, ... +trig functions trigonometric element-wise functions: cos, sin, tan, ... @@ -2106,8 +2108,8 @@ The following subset of operations & functions is available for sparse matri
  • diagonal views
  • saving and loading (using arma_binary, coord_ascii, and csv_ascii formats)
  • element-wise functions: abs(), ceil(), conj(), floor(), imag(), real(), round(), sign(), sqrt(), square(), trunc()
    • -
  • scalar functions of matrices: accu(), as_scalar(), dot(), norm(), trace()
    • -
  • vector valued functions of matrices: diagvec(), min(), max(), nonzeros(), sum(), mean(), var(), vectorise()
    • +
  • scalar functions of matrices: accu(), as_scalar(), dot(), norm(), norm2est(), trace()
    • +
  • vector valued functions of matrices: diagvec(), min(), max(), nonzeros(), sum(), mean(), var(), vecnorm(), vectorise()
  • matrix valued functions of matrices: clamp(), diagmat(), flipud()/fliplr(), join_rows(), join_cols(), kron(), normalise(), repelem(), repmat(), reshape(), resize(), reverse(), symmatu()/symmatl(), trimatu()/trimatl(), .t(), trans()
  • generated matrices: speye(), spones(), sprandu(), sprandn(), zeros()
  • eigen and svd decomposition: eigs_sym(), eigs_gen(), svds()
    • @@ -10565,7 +10567,7 @@ See also:
    norm( X, p )