changeset 28754:86dc599fff0f

doc: spellcheck documentation. * aspell-octave.en.pws: Add new words to Octave-specific dictionary. * dmperm.cc, memory.m: Fix spelling.
author Rik <rik@octave.org>
date Thu, 17 Sep 2020 11:30:53 -0700
parents e82484e1b2f6
children c1a110df224e
files doc/interpreter/doccheck/aspell-octave.en.pws libinterp/corefcn/dmperm.cc scripts/miscellaneous/memory.m
diffstat 3 files changed, 115 insertions(+), 102 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/doccheck/aspell-octave.en.pws	Thu Sep 17 11:07:19 2020 -0700
+++ b/doc/interpreter/doccheck/aspell-octave.en.pws	Thu Sep 17 11:30:53 2020 -0700
@@ -1,13 +1,14 @@
 personal_ws-1.1 en 1
 AbsTol
 accumarray
+Acknowledgements
 acknowledgements
-Acknowledgements
 adams
 Affero
 afterwards
 al
 aleph
+allocatable
 amd
 amongst
 anisotropic
@@ -21,8 +22,8 @@
 arpack
 ArrayValued
 ascii
+associativity
 Associativity
-associativity
 ast
 async
 atan
@@ -50,10 +51,10 @@
 backtrace
 bartlett
 Barycentric
+BaseValue
 basevalue
-BaseValue
+BDF
 bdf
-BDF
 benchmarking
 betacdf
 betainc
@@ -64,6 +65,7 @@
 BFGS
 BICG
 BiConjugate
+biharmonic
 bincoeff
 binocdf
 binoinv
@@ -75,6 +77,7 @@
 blas
 bmp
 boolean
+Booleans
 boolMatrix
 boxoff
 boxon
@@ -85,10 +88,10 @@
 broadcastable
 BufSize
 builtin
+bulleted
 Bulleted
-bulleted
+buttondownfcn
 ButtonDownFcn
-buttondownfcn
 BV
 BZ
 bzip
@@ -149,8 +152,8 @@
 ColorOrder
 colororder
 colperm
+CommentStyle
 commentstyle
-CommentStyle
 ComplexEqn
 cond
 condest
@@ -159,6 +162,7 @@
 const
 contextless
 contourc
+ConvertInfAndNaN
 convhull
 Convolve
 copyrightable
@@ -174,8 +178,8 @@
 CreateFcn
 CRLF
 crossflow
+crout
 Crout
-crout
 cryptographic
 CSparse
 CSV
@@ -201,6 +205,7 @@
 daspk
 dasrt
 dassl
+DataAspectRatio
 dataset
 datasets
 datasource
@@ -221,8 +226,8 @@
 delaunay
 Delaunay
 delaunayn
+deletefcn
 DeleteFcn
-deletefcn
 delim
 deltaX
 demi
@@ -239,8 +244,8 @@
 dimensionally
 dir
 disp
+DisplayName
 displayname
-DisplayName
 displayrange
 dMatrix
 dmperm
@@ -259,8 +264,8 @@
 dt
 dx
 dy
+eastoutside
 EastOutside
-eastoutside
 Econometrics
 edgecolor
 EdgeLighting
@@ -273,29 +278,29 @@
 elementwise
 elseif
 emacs
+EmptyValue
 emptyvalue
-EmptyValue
 encodings
 endfunction
+Endian
 endian
-Endian
 endif
+EndOfLine
 endofline
-EndOfLine
 EOF
 EOLs
 eps
 eq
 equidistributed
+Equilibration
 equilibration
-Equilibration
 equispaced
 erf
 erfc
 erfi
 errno
+Errorbar
 errorbar
-Errorbar
 errorbars
 Errorbars
 errordlg
@@ -319,8 +324,8 @@
 FaceColor
 FaceLighting
 FaceNormals
+facevertexcdata
 FaceVertexCData
-facevertexcdata
 factorizations
 fcdf
 femmodel
@@ -334,8 +339,8 @@
 fieldname
 fieldnames
 FIFOs
+filename
 FileName
-filename
 filenames
 filepaths
 Filesystem
@@ -346,12 +351,14 @@
 fitboxtotext
 FIXME
 flac
+fltk
 FLTK
-fltk
 fminsearch
 fminunc
 fontconfig
+FontConfig
 fontname
+FontName
 forall
 forcecelloutput
 foregroundcolor
@@ -399,8 +406,8 @@
 glibc
 globbing
 glpk
+GLS
 gls
-GLS
 glyphs
 GMRES
 Gnuplot
@@ -425,16 +432,16 @@
 gzip
 gzipped
 Hadamard
+handlevisibility
 HandleVisibility
-handlevisibility
 Hankel
+Hanning
 hanning
-Hanning
 hardcode
 hardcoded
 hardcoding
+hdf
 HDF
-hdf
 HeaderLines
 headerlines
 headlength
@@ -458,8 +465,8 @@
 horizontalalignment
 horzcat
 hostname
+HSV
 hsv
-HSV
 html
 hygecdf
 hygeinv
@@ -470,12 +477,13 @@
 ict
 IDE
 IEC
+IEEE
 ieee
-IEEE
 ifelse
 ifft
 ifftn
 ignorecase
+IgnoreCase
 ij
 ilu
 ilutp
@@ -483,16 +491,16 @@
 imag
 ImageMagick
 includenan
+Indices
 indices
-Indices
 infeasible
 infty
 init
 InitialSlope
 InitialStep
 InitialValue
+Inline
 inline
-Inline
 inmax
 inmin
 inpolygon
@@ -551,6 +559,7 @@
 jpeg
 JPEG
 jpg
+JSON
 jvm
 JVM's
 kendall
@@ -574,8 +583,8 @@
 ldots
 le
 leaveInPlace
+leftarrow
 Leftarrow
-leftarrow
 leftrightarrow
 leq
 lfloor
@@ -607,8 +616,8 @@
 logninv
 lognpdf
 lognrnd
+lookup
 Lookup
-lookup
 lookups
 lossless
 lsode
@@ -649,8 +658,8 @@
 meshgridded
 meshstyle
 metadata
+MetaFile
 Metafile
-MetaFile
 metafile
 metafiles
 Metafont
@@ -669,8 +678,8 @@
 mkoctfile
 mldivide
 mmd
+mmm
 MMM
-mmm
 mmmm
 mmmyy
 mmmyyyy
@@ -698,13 +707,14 @@
 nabla
 NAMESPACE
 namespace
+NaN
 nan
-NaN
 nancond
 nanflag
 NaNs
 nargin
 nargout
+natively
 nbincdf
 nbininv
 nbinpdf
@@ -749,8 +759,8 @@
 normpdf
 normrnd
 northeastoutside
+NorthOutside
 northoutside
-NorthOutside
 northwestoutside
 noscal
 noshare
@@ -767,8 +777,8 @@
 ODEs
 offscreen
 ofig
+ogg
 Ogg
-ogg
 OKString
 OLS
 omitnan
@@ -800,23 +810,23 @@
 paperposition
 paperpositionmode
 papersize
+PaperUnits
 paperunits
-PaperUnits
 parametrically
 parseparams
+PBM
 pbm
-PBM
 PBMplus
 pc
+pcg
 PCG
-pcg
 pchip
 pcr
 pcre
 PCRE
 PCX
+PDF
 pdf
-PDF
 pdflatex
 pentadiagonal
 periodogram
@@ -825,10 +835,11 @@
 PGMRES
 PHP
 pict
+piecewise
 Piecewise
-piecewise
 pinv
 PixelRegion
+PlotBoxAspectRatio
 PNG
 png
 poisscdf
@@ -852,17 +863,18 @@
 preallocate
 preconditioner
 preconditioners
+preformatted
 Preformatted
-preformatted
 premultiplied
 Prepend
 prepended
 preselected
 presolver
+PrettyWriter
 printf
 priori
+Profiler
 profiler
-Profiler
 programmatically
 prolate
 PromptString
@@ -889,8 +901,8 @@
 quadl
 quadpack
 quadv
+quantile
 Quantile
-quantile
 quantiles
 quantization
 quartic
@@ -936,11 +948,11 @@
 reproducibility
 resampled
 resampling
+Resize
 resize
-Resize
 resized
+Resizing
 resizing
-Resizing
 resnorm
 resparsify
 restacks
@@ -949,8 +961,8 @@
 restorePrevious
 RET
 retarget
+returnonerror
 ReturnOnError
-returnonerror
 rfloor
 rgb
 RGB
@@ -996,8 +1008,8 @@
 slcidx
 slx
 southeastoutside
+SouthOutside
 southoutside
-SouthOutside
 southwestoutside
 sp
 spadesuit
@@ -1029,8 +1041,8 @@
 ss
 sT
 stairstep
+Startup
 startup
-Startup
 statinfo
 stdin
 stdout
@@ -1038,9 +1050,12 @@
 STFT
 str
 strcmp
+streamribbon
+Streamribbons
+streamribbons
 streamtube
+Streamtubes
 streamtubes
-Streamtubes
 stringanchors
 strncmp
 strncmpi
@@ -1050,15 +1065,15 @@
 struct
 structs
 subarrays
+Subclasses
 subclasses
-Subclasses
 subdiagonal
 subdiagonals
 subdirectories
 subdirectory
 subexpressions
+subfunction
 Subfunction
-subfunction
 Subfunctions
 subfunctions
 subinterval
@@ -1098,13 +1113,13 @@
 supseteq
 surd
 SV
+SVD
 svd
-SVD
 svds
+svg
 SVG
-svg
+Sym
 sym
-Sym
 SYMAMD
 symamd
 symbfact
@@ -1144,8 +1159,8 @@
 TolFun
 TolX
 toolchain
+toolkits
 Toolkits
-toolkits
 toplevel
 TP
 tpdf
@@ -1163,8 +1178,8 @@
 trisurf
 trivariate
 trnd
+TrueColor
 truecolor
-TrueColor
 tuples
 txi
 typedefs
@@ -1174,37 +1189,37 @@
 uchar
 UHESS
 UI
+uibuttongroup
 Uibuttongroup
-uibuttongroup
 uibuttongroups
+uicontextmenu
 Uicontextmenu
-uicontextmenu
+uicontrol
 Uicontrol
-uicontrol
 uicontrols
 UID
 uimenu
 uint
+Uipanel
 uipanel
-Uipanel
 uipanels
+Uipushtool
 uipushtool
-Uipushtool
 uipushtools
 uiputfile
 uitab
 uitable
 Uitable
+uitoggletool
 Uitoggletool
-uitoggletool
+Uitoolbar
 uitoolbar
-Uitoolbar
 ulong
 Ultrix
 umfpack
 uminus
+Unary
 unary
-Unary
 unconvertible
 undirected
 unifcdf
@@ -1249,8 +1264,8 @@
 vech
 vectorization
 vectorize
+Vectorized
 vectorized
-Vectorized
 vectorizing
 vee
 versa
@@ -1269,17 +1284,17 @@
 warndlg
 wav
 WAV
+waypoints
 WayPoints
 Waypoints
-waypoints
 wblcdf
 wblinv
 wblpdf
 wblrnd
+WestOutside
 westoutside
-WestOutside
+whitespace
 Whitespace
-whitespace
 whos
 wienrnd
 Wikipedia
@@ -1346,8 +1361,8 @@
 ypos
 yticklabels
 yticks
+YY
 yy
-YY
 YYYY
 yyyy
 yyyymmddTHHMMSS
--- a/libinterp/corefcn/dmperm.cc	Thu Sep 17 11:07:19 2020 -0700
+++ b/libinterp/corefcn/dmperm.cc	Thu Sep 17 11:30:53 2020 -0700
@@ -129,17 +129,16 @@
 Perform a @nospell{Dulmage-Mendelsohn} permutation of the sparse matrix
 @var{A}.
 
-With a single output argument @code{dmperm} return a maximum matching
-@var{p} such that @code{p(j) = i} if column @var{j}
-is matched to row @var{i}, or 0 if column @var{j} is unmatched.  If
-@var{A} is square and full structural rank, @var{p} is a row permutation
-and @code{A(p,:)} has a zero-free diagonal.  The structural
-rank of @var{A} is @code{sprank(A) = sum(p>0)}.
+With a single output argument @code{dmperm}, return a maximum matching @var{p}
+such that @code{p(j) = i} if column @var{j} is matched to row @var{i}, or 0 if
+column @var{j} is unmatched.  If @var{A} is square and full structural rank,
+@var{p} is a row permutation and @code{A(p,:)} has a zero-free diagonal.  The
+structural rank of @var{A} is @code{sprank(A) = sum(p>0)}.
 
-Called with two or more output arguments, return the Dulmage-Mendelsohn
-decomposition of @var{A}.  @var{p} and @var{q} are permutation vectors.
-@var{cc} and @var{rr} are vectors of length 5.  @code{c = A(p,q)} is
-split into a 4-by-4 set of coarse blocks:
+Called with two or more output arguments, return the
+@nospell{Dulmage-Mendelsohn} decomposition of @var{A}.  @var{p} and @var{q} are
+permutation vectors.  @var{cc} and @var{rr} are vectors of length 5.
+@code{c = A(p,q)} is split into a 4-by-4 set of coarse blocks:
 
 @example
 @group
@@ -152,33 +151,32 @@
 
 @noindent
 where @code{A12}, @code{A23}, and @code{A34} are square with zero-free
-diagonals.  The columns of @code{A11} are the unmatched columns, and the
-rows of @code{A44} are the unmatched rows.  Any of these blocks can be
-empty.  In the "coarse" decomposition, the (i,j)-th block is
+diagonals.  The columns of @code{A11} are the unmatched columns, and the rows
+of @code{A44} are the unmatched rows.  Any of these blocks can be empty.  In
+the "coarse" decomposition, the (i,j)-th block is
 @code{C(rr(i):rr(i+1)-1,cc(j):cc(j+1)-1)}.  In terms of a linear system,
 @code{[A11 A12]} is the underdetermined part of the system (it is always
-rectangular and with more columns and rows, or 0-by-0), @code{A23} is
-the well-determined part of the system (it is always square), and
-@code{[A34 ; A44]} is the over-determined part of the system (it is
-always rectangular with more rows than columns, or 0-by-0).
+rectangular and with more columns and rows, or 0-by-0), @code{A23} is the
+well-determined part of the system (it is always square), and
+@code{[A34 ; A44]} is the over-determined part of the system (it is always
+rectangular with more rows than columns, or 0-by-0).
 
-The structural rank of @var{A} is @code{sprank (A) = rr(4)-1}, which is
-an upper bound on the numerical rank of @var{A}.
+The structural rank of @var{A} is @code{sprank (A) = rr(4)-1}, which is an
+upper bound on the numerical rank of @var{A}.
 @code{sprank(A) = rank(full(sprand(A)))} with probability 1 in exact
 arithmetic.
 
-The @code{A23} submatrix is further subdivided into block upper
-triangular form via the "fine" decomposition (the strongly-connected
-components of @code{A23}).  If @var{A} is square and structurally
-non-singular, @code{A23} is the entire matrix.
+The @code{A23} submatrix is further subdivided into block upper triangular form
+via the "fine" decomposition (the strongly-connected components of @code{A23}).
+If @var{A} is square and structurally non-singular, @code{A23} is the entire
+matrix.
 
-@code{C(r(i):r(i+1)-1,s(j):s(j+1)-1)} is the (i,j)-th block of
-the fine decomposition.  The (1,1) block is the rectangular block
-@code{[A11 A12]}, unless this block is 0-by-0.  The (b,b) block is the
-rectangular block @code{[A34 ; A44]}, unless this block is 0-by-0, where
-@code{b = length(r)-1}.  All other blocks of the form
-@code{C(r(i):r(i+1)-1,s(i):s(i+1)-1)} are diagonal blocks of
-@code{A23}, and are square with a zero-free diagonal.
+@code{C(r(i):r(i+1)-1,s(j):s(j+1)-1)} is the (i,j)-th block of the fine
+decomposition.  The (1,1) block is the rectangular block @code{[A11 A12]},
+unless this block is 0-by-0.  The (b,b) block is the rectangular block
+@code{[A34 ; A44]}, unless this block is 0-by-0, where @code{b = length(r)-1}.
+All other blocks of the form @code{C(r(i):r(i+1)-1,s(i):s(i+1)-1)} are diagonal
+blocks of @code{A23}, and are square with a zero-free diagonal.
 
 The method used is described in: @nospell{A. Pothen & C.-J. Fan.}
 @cite{Computing the Block Triangular Form of a Sparse Matrix}.
--- a/scripts/miscellaneous/memory.m	Thu Sep 17 11:07:19 2020 -0700
+++ b/scripts/miscellaneous/memory.m	Thu Sep 17 11:30:53 2020 -0700
@@ -39,7 +39,7 @@
 ## Maximum size for an array to be allocated.  Be aware that this includes
 ## @emph{all} physical memory and swap space.  Allocating that amount of memory
 ## might result in system instability, data corruption and/or file system
-## curruption.  Note that dependend on the platform (32bit systems), the
+## corruption.  Note that depending on the platform (32-bit systems), the
 ## largest contiguous memory block might further limit the maximum possible
 ## allocatable array.  This check is currently not implemented.
 ##
@@ -48,7 +48,7 @@
 ##
 ## @item @var{ram_available_all_arrays}
 ## The maximum size for an array that can be allocated in physical memory
-## (excluding swap space).  Note that dependend on the platform (32bit
+## (excluding swap space).  Note that depending on the platform (32-bit
 ## systems), the largest contiguous memory block might further limit the
 ## maximum possible allocatable array.  This check is currently not
 ## implemented.
@@ -68,10 +68,10 @@
 ##
 ## @table @code
 ## @item @var{PhysicalMemory.Available}
-## The currently available pyhsical memory in bytes.
+## The currently available physical memory in bytes.
 ##
 ## @item @var{PhysicalMemory.Total}
-## The total pyhsical memory in bytes.
+## The total physical memory in bytes.
 ##
 ## @item @var{SystemMemory.Available}
 ## The currently available memory (including swap space) in bytes.