Mercurial > octave-nkf
view liboctave/dbleSVD.h @ 8828:8463d1a2e544
Doc fixes.
* 2]$$. => 2].$$
* @var{extrapval} => @var{extrapval}.
* call helloworld.oct => called @file{helloworld.oct}
* @itemize => @table @code
* shows. => shows:
* save => @code{save}
* @ref{Breakpoints} => @pxref{Breakpoints}
* add @noindent following example
* which is computed => and compute it
* clarify wording
* remove comma
* good => well
* set => number
* by writing => with the command
* has the option of directly calling => can call
* [-like-] {+of the right size,+}
* solvers => routines
* handle => test for
* add introductory section
* add following
* {+the+} [0..bitmax] => [0,bitmax]
* of the => with
* number => value
* add usual
* Besides when doing comparisons, logical => Logical {+also+}
* array comparison => array, comparisons
* param => parameter
* works very similar => is similar
* strings, => strings
* most simple => simplest
* easier => more easily
* like => as
* called => called,
* clarify wording
* you should simply type => use
* clarify wording
* means => way
* equally => also
* [-way much-] {+way+}
* add with mean value parameter given by the first argument, @var{l}
* add Functions described as @dfn{mapping functions} apply the given
operation to each element when given a matrix argument.
* in this brief introduction => here
* It is worth noticing => Note
* add following
* means => ways
author | Brian Gough <bjg@network-theory.co.uk> |
---|---|
date | Fri, 20 Feb 2009 11:17:01 -0500 |
parents | a1dbe9d80eee |
children | d865363208d6 |
line wrap: on
line source
/* Copyright (C) 1994, 1995, 1996, 1997, 2000, 2002, 2003, 2004, 2005, 2006, 2007 John W. Eaton This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #if !defined (octave_SVD_h) #define octave_SVD_h 1 #include <iostream> #include "dDiagMatrix.h" #include "dMatrix.h" class OCTAVE_API SVD { public: enum type { std, economy, sigma_only }; SVD (void) : sigma (), left_sm (), right_sm () { } SVD (const Matrix& a, type svd_type = SVD::std) { init (a, svd_type); } SVD (const Matrix& a, octave_idx_type& info, type svd_type = SVD::std) { info = init (a, svd_type); } SVD (const SVD& a) : type_computed (a.type_computed), sigma (a.sigma), left_sm (a.left_sm), right_sm (a.right_sm) { } SVD& operator = (const SVD& a) { if (this != &a) { type_computed = a.type_computed; sigma = a.sigma; left_sm = a.left_sm; right_sm = a.right_sm; } return *this; } ~SVD (void) { } DiagMatrix singular_values (void) const { return sigma; } Matrix left_singular_matrix (void) const; Matrix right_singular_matrix (void) const; friend std::ostream& operator << (std::ostream& os, const SVD& a); private: SVD::type type_computed; DiagMatrix sigma; Matrix left_sm; Matrix right_sm; octave_idx_type init (const Matrix& a, type svd_type = std); }; #endif /* ;;; Local Variables: *** ;;; mode: C++ *** ;;; End: *** */