phynexis-deps/armadillo-code
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ensure form of 'caveat' marker is consistent

Browse Source
This commit is contained in:
conrad
2022-09-27 13:32:22 +10:00
parent 6c2ed1b2f0
commit 02a8cd420b
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs.html
+15 -15
View File
@@ -1812,7 +1812,7 @@ Constructors, where <i>object_type</i> is another class, eg. <i>vec</i>, <i>mat<
</li>
<br>
<li>
<b>Caveat</b>: to store a set of matrices of the same size, the <a href="#Cube">Cube</a> class is more efficient
<b>Caveat:</b> to store a set of matrices of the same size, the <a href="#Cube">Cube</a> class is more efficient
</li>
<br>
<li>
@@ -7108,7 +7108,7 @@ the above settings can be combined using the <code>+</code> operator; for exampl
</li>
<br>
<li>
<b>Caveat</b>:
<b>Caveat:</b>
for saving&thinsp;/&thinsp;loading HDF5 files, support for HDF5 must be enabled within Armadillo's <a href="#config_hpp">configuration</a>;
the <i>hdf5.h</i> header file must be available on your system and you will need to link with the HDF5 library (eg. <code><i>-lhdf5</i></code>)
</li>
@@ -8940,7 +8940,7 @@ See also:
</ul>
</li>
<br>
<li><b>Caveat</b>: <a href="#log_det">log_det()</a> is preferred, as it's less likely to suffer from numerical underflows/overflows</li>
<li><b>Caveat:</b> <a href="#log_det">log_det()</a> is preferred, as it's less likely to suffer from numerical underflows/overflows</li>
<br>
<li>
Examples:
@@ -9218,9 +9218,9 @@ See also:
</ul>
</li>
<br>
<li><b>Caveat</b>: if matrix <i>A</i> is symmetric, using <a href="#expmat_sym">expmat_sym()</a> is faster</li>
<li><b>Caveat:</b> if matrix <i>A</i> is symmetric, using <a href="#expmat_sym">expmat_sym()</a> is faster</li>
<br>
<li><b>Caveat</b>: the matrix exponential operation is generally <b>not</b> the same as applying the <a href="#misc_fns">exp()</a> function to each element</li>
<li><b>Caveat:</b> the matrix exponential operation is generally <b>not</b> the same as applying the <a href="#misc_fns">exp()</a> function to each element</li>
<br>
<li>
Examples:
@@ -9267,10 +9267,10 @@ See also:
</li>
<!--
<br>
<li><b>Caveat</b>: there is no explicit check whether <i>A</i> is symmetric/hermitian</li>
<li><b>Caveat:</b> there is no explicit check whether <i>A</i> is symmetric/hermitian</li>
-->
<br>
<li><b>Caveat</b>: the matrix exponential operation is generally <b>not</b> the same as applying the <a href="#misc_fns">exp()</a> function to each element</li>
<li><b>Caveat:</b> the matrix exponential operation is generally <b>not</b> the same as applying the <a href="#misc_fns">exp()</a> function to each element</li>
<br>
<li>
Examples:
@@ -10225,9 +10225,9 @@ See also:
</ul>
</li>
<br>
<li><b>Caveat</b>: if matrix <i>A</i> is symmetric positive definite, using <a href="#logmat_sympd">logmat_sympd()</a> is faster</li>
<li><b>Caveat:</b> if matrix <i>A</i> is symmetric positive definite, using <a href="#logmat_sympd">logmat_sympd()</a> is faster</li>
<br>
<li><b>Caveat</b>: the matrix logarithm operation is generally <b>not</b> the same as applying the <a href="#misc_fns">log()</a> function to each element</li>
<li><b>Caveat:</b> the matrix logarithm operation is generally <b>not</b> the same as applying the <a href="#misc_fns">log()</a> function to each element</li>
<br>
<li>
Examples:
@@ -10271,10 +10271,10 @@ See also:
</li>
<!--
<br>
<li><b>Caveat</b>: there is no explicit check whether <i>A</i> is symmetric/hermitian positive definite</li>
<li><b>Caveat:</b> there is no explicit check whether <i>A</i> is symmetric/hermitian positive definite</li>
-->
<br>
<li><b>Caveat</b>: the matrix logarithm operation is generally <b>not</b> the same as applying the <a href="#misc_fns">log()</a> function to each element</li>
<li><b>Caveat:</b> the matrix logarithm operation is generally <b>not</b> the same as applying the <a href="#misc_fns">log()</a> function to each element</li>
<br>
<li>
Examples:
@@ -11400,9 +11400,9 @@ See also:
If matrix <i>A</i> appears to be singular, an approximate square root is attempted; additionally, <i>sqrtmat(B,A)</i> returns a bool set to false
</li>
<br>
<li><b>Caveat</b>: if matrix <i>A</i> is symmetric positive definite, using <a href="#sqrtmat_sympd">sqrtmat_sympd()</a> is faster</li>
<li><b>Caveat:</b> if matrix <i>A</i> is symmetric positive definite, using <a href="#sqrtmat_sympd">sqrtmat_sympd()</a> is faster</li>
<br>
<li><b>Caveat</b>: the square root of a matrix is generally <b>not</b> the same as applying the <a href="#misc_fns">sqrt()</a> function to each element</li>
<li><b>Caveat:</b> the square root of a matrix is generally <b>not</b> the same as applying the <a href="#misc_fns">sqrt()</a> function to each element</li>
<br>
<li>
Examples:
@@ -11448,10 +11448,10 @@ See also:
</li>
<!--
<br>
<li><b>Caveat</b>: there is no explicit check whether <i>A</i> is symmetric/hermitian positive definite</li>
<li><b>Caveat:</b> there is no explicit check whether <i>A</i> is symmetric/hermitian positive definite</li>
-->
<br>
<li><b>Caveat</b>: the matrix square root operation is generally <b>not</b> the same as applying the <a href="#misc_fns">sqrt()</a> function to each element</li>
<li><b>Caveat:</b> the matrix square root operation is generally <b>not</b> the same as applying the <a href="#misc_fns">sqrt()</a> function to each element</li>
<br>
<li>
Examples: