Mercurial > octave-nkf
view liboctave/SparseQR.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 | 82be108cc558 |
children | eb63fbe60fab |
line wrap: on
line source
/* Copyright (C) 2005, 2006, 2007 David Bateman 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 (sparse_QR_h) #define sparse_QR_h 1 #include <iostream> #include "dMatrix.h" #include "CMatrix.h" #include "dSparse.h" #include "CSparse.h" #include "oct-sparse.h" #ifdef IDX_TYPE_LONG #define CXSPARSE_DNAME(name) cs_dl ## name #else #define CXSPARSE_DNAME(name) cs_di ## name #endif class OCTAVE_API SparseQR { protected: class SparseQR_rep { public: SparseQR_rep (const SparseMatrix& a, int order); ~SparseQR_rep (void); #ifdef HAVE_CXSPARSE bool ok (void) const { return (N && S); } #else bool ok (void) const { return false; } #endif SparseMatrix V (void) const; ColumnVector Pinv (void) const; ColumnVector P (void) const; SparseMatrix R (const bool econ) const; Matrix C (const Matrix &b) const; Matrix Q (void) const; int count; octave_idx_type nrows; #ifdef HAVE_CXSPARSE CXSPARSE_DNAME (s) *S; CXSPARSE_DNAME (n) *N; #endif }; private: SparseQR_rep *rep; public: SparseQR (void) : rep (new SparseQR_rep (SparseMatrix(), 0)) { } SparseQR (const SparseMatrix& a, int order = 0) : rep (new SparseQR_rep (a, order)) { } SparseQR (const SparseQR& a) : rep (a.rep) { rep->count++; } ~SparseQR (void) { if (--rep->count <= 0) delete rep; } SparseQR& operator = (const SparseQR& a) { if (this != &a) { if (--rep->count <= 0) delete rep; rep = a.rep; rep->count++; } return *this; } bool ok (void) const { return rep->ok(); } SparseMatrix V (void) const { return rep->V(); } ColumnVector Pinv (void) const { return rep->P(); } ColumnVector P (void) const { return rep->P(); } SparseMatrix R (const bool econ = false) const { return rep->R(econ); } Matrix C (const Matrix &b) const { return rep->C(b); } Matrix Q (void) const { return rep->Q(); } friend Matrix qrsolve (const SparseMatrix &a, const Matrix &b, octave_idx_type &info); friend SparseMatrix qrsolve (const SparseMatrix &a, const SparseMatrix &b, octave_idx_type &info); friend ComplexMatrix qrsolve (const SparseMatrix &a, const ComplexMatrix &b, octave_idx_type &info); friend SparseComplexMatrix qrsolve (const SparseMatrix &a, const SparseComplexMatrix &b, octave_idx_type &info); protected: #ifdef HAVE_CXSPARSE CXSPARSE_DNAME (s) * S (void) { return rep->S; } CXSPARSE_DNAME (n) * N (void) { return rep->N; } #endif }; // Publish externally used friend functions. extern Matrix qrsolve (const SparseMatrix &a, const Matrix &b, octave_idx_type &info); extern Matrix qrsolve (const SparseMatrix &a, const MArray2<double> &b, octave_idx_type &info); extern SparseMatrix qrsolve (const SparseMatrix &a, const SparseMatrix &b, octave_idx_type &info); extern ComplexMatrix qrsolve (const SparseMatrix &a, const ComplexMatrix &b, octave_idx_type &info); extern ComplexMatrix qrsolve (const SparseMatrix &a, const MArray2<Complex> &b, octave_idx_type &info); extern SparseComplexMatrix qrsolve (const SparseMatrix &a, const SparseComplexMatrix &b, octave_idx_type &info); #endif /* ;;; Local Variables: *** ;;; mode: C++ *** ;;; End: *** */