From d3c19984c01386f3e0177d8eaa1c2d6175492c28 Mon Sep 17 00:00:00 2001
From: Jesper Andersson <jesper@fmrib.ox.ac.uk>
Date: Tue, 2 Oct 2012 09:43:08 +0000
Subject: [PATCH] Added protected read-only access to some internal data
---
SpMat.h | 104 ++++++++++++++++++--------------------------------------
1 file changed, 33 insertions(+), 71 deletions(-)
diff --git a/SpMat.h b/SpMat.h
index 32c844c..9e1cd8a 100644
--- a/SpMat.h
+++ b/SpMat.h
@@ -89,12 +89,11 @@ template<class T>
class SpMat
{
public:
- SpMat() : _m(0), _n(0), _nz(0), _ri(0), _val(0), _pw(false), _ei(*this,true) {}
- SpMat(unsigned int m, unsigned int n) : _m(m), _n(n), _nz(0), _ri(n), _val(n), _pw(false), _ei(*this,true) {}
+ SpMat() : _m(0), _n(0), _nz(0), _ri(0), _val(0), _pw(false) {}
+ SpMat(unsigned int m, unsigned int n) : _m(m), _n(n), _nz(0), _ri(n), _val(n), _pw(false) {}
SpMat(unsigned int m, unsigned int n, const unsigned int *irp, const unsigned int *jcp, const double *sp);
SpMat(const NEWMAT::GeneralMatrix& M);
SpMat(const std::string& fname);
- SpMat(const SpMat<T>& s) : _m(s._m), _n(s._n), _nz(s._nz), _ri(s._ri), _val(s._val), _pw(s._pw), _ei(*this,true) {}
~SpMat() {}
unsigned int Nrows() const {return(_m);}
@@ -113,7 +112,6 @@ public:
void WarningsOn() {_pw=true;}
void WarningsOff() {_pw=false;}
- // All access to individual elements is one-offset, i.e. same as Matlab and NEMAT
T Peek(unsigned int r, unsigned int c) const;
T operator()(unsigned int r, unsigned int c) const {return(Peek(r,c));} // Read-only
@@ -122,12 +120,6 @@ public:
void SetColumn(unsigned int c, const NEWMAT::ColumnVector& col, double eps=0.0); // Set a whole column (obliterating what was there before)
void AddTo(unsigned int r, unsigned int c, const T& v) {here(r,c) += v;} // Add value to a single (possibly existing) value
- SpMat<T>& operator=(const SpMat& M)
- {
- if (this == &M) return(*this);
- _m=M._m; _n=M._n; _nz=M._nz; _ri=M._ri; _val=M._val; _pw=M._pw; _ei=M._ei;
- return(*this);
- }
SpMat<T>& operator+=(const SpMat& M)
{
if (same_sparsity(M)) return(add_same_sparsity_mat_to_me(M,1));
@@ -152,7 +144,6 @@ public:
const SpMat<T> TransMultSelf() const {return(TransMult(*this));} // Returns transpose(*this)*(*this)
const SpMat<T> t() const; // Returns transpose(*this). Avoid, if at all possible.
- const NEWMAT::ReturnMatrix Diag() const; // Return the values on the diagonal in a columnvector
friend class Accumulator<T>;
@@ -178,42 +169,9 @@ public:
boost::shared_ptr<Preconditioner<T> > C,
const NEWMAT::ColumnVector& x_init) const;
- // Declaration and definition of bundled Iterator class
-
- class Iterator : public std::iterator<std::forward_iterator_tag, T> {
- public:
- Iterator(SpMat<T>& mat, bool oob=false) : _mat(mat), _i(0), _oob(oob)
- {
- _j = 0;
- while (_j < _mat._n && !_mat._ri[_j].size()) _j++;
- if (_j == _mat._n) _oob = true;
- }
- ~Iterator() {}
- Iterator& operator=(const Iterator& I) { _i=I._i; _j=I._j; _oob=I._oob; return(*this); } // _mat deliberately not assigned
- bool operator==(const Iterator& other) { return(&_mat==&other._mat && ((_oob && other._oob) || (_i==other._i && _j==other._j))); }
- bool operator!=(const Iterator& other) { return(!(*this==other)); }
- T& operator*() { return((_mat._val[_j])[_i]); }
- Iterator& operator++() // Prefix operator
- {
- if (++_i < _mat._ri[_j].size()) return(*this);
- else {
- while (++_j < _mat._n && !_mat._ri[_j].size()) ;
- }
- if (_j == _mat._n) _oob = true;
- else _i = 0;
- return(*this);
- }
- unsigned int Row() { return((_mat._ri[_j])[_i]+1); }
- unsigned int Col() { return(_j+1); }
- private:
- SpMat<T>& _mat;
- unsigned int _i;
- unsigned int _j;
- bool _oob;
- };
-
- Iterator begin() { return(Iterator(*this)); }
- const Iterator& end() { return(_ei); }
+protected:
+ const std::vector<unsigned int>& get_ri(unsigned int i) const;
+ const std::vector<T>& get_val(unsigned int i) const;
private:
unsigned int _m;
@@ -222,7 +180,6 @@ private:
std::vector<std::vector<unsigned int> > _ri;
std::vector<std::vector<T> > _val;
bool _pw; // Print Warnings
- Iterator _ei;
bool found(const std::vector<unsigned int>& ri, unsigned int key, int& pos) const;
T& here(unsigned int r, unsigned int c);
@@ -355,7 +312,7 @@ private:
template<class T>
SpMat<T>::SpMat(unsigned int m, unsigned int n, const unsigned int *irp, const unsigned int *jcp, const double *sp)
- : _m(m), _n(n), _nz(0), _ri(n), _val(n), _pw(false), _ei(*this,true)
+ : _m(m), _n(n), _nz(0), _ri(n), _val(n), _pw(false)
{
_nz = jcp[n];
unsigned long nz = 0;
@@ -385,7 +342,7 @@ SpMat<T>::SpMat(unsigned int m, unsigned int n, const unsigned int *irp, const u
template<class T>
SpMat<T>::SpMat(const NEWMAT::GeneralMatrix& M)
- : _m(M.Nrows()), _n(M.Ncols()), _nz(0), _ri(M.Ncols()), _val(M.Ncols()), _pw(false), _ei(*this,true)
+ : _m(M.Nrows()), _n(M.Ncols()), _nz(0), _ri(M.Ncols()), _val(M.Ncols()), _pw(false)
{
double *m = static_cast<double *>(M.Store());
@@ -421,7 +378,7 @@ SpMat<T>::SpMat(const NEWMAT::GeneralMatrix& M)
template<class T>
SpMat<T>::SpMat(const std::string& fname)
- : _m(0), _n(0), _nz(0), _ri(0), _val(0), _pw(false), _ei(*this,true)
+: _m(0), _n(0), _nz(0), _ri(0), _val(0), _pw(false)
{
// First read data into (nz+1)x3 NEWMAT matrix
NEWMAT::Matrix rcv;
@@ -665,26 +622,6 @@ const SpMat<T> SpMat<T>::t() const
return(t_mat);
}
-/////////////////////////////////////////////////////////////////////
-//
-// Returns the values on the diagonal as a column vector
-//
-/////////////////////////////////////////////////////////////////////
-
-template<class T>
-const NEWMAT::ReturnMatrix SpMat<T>::Diag() const
-{
- if (_m != _n) throw SpMatException("Diag: matrix must be square");
-
- NEWMAT::ColumnVector ov(_m);
- for (unsigned int i=1; i<=_m; i++) {
- ov(i) = Peek(i,i);
- }
- ov.Release();
-
- return(ov);
-}
-
/////////////////////////////////////////////////////////////////////
//
// Sets the values of an entire column, destroying any previous content.
@@ -1059,6 +996,31 @@ const SpMat<T> operator&(const SpMat<T>& th, const NEWMAT::GeneralMatrix& bh)
return(SpMat<T>(th) &= SpMat<T>(bh));
}
+/*###################################################################
+##
+## Here starts protected functions
+##
+###################################################################*/
+
+/////////////////////////////////////////////////////////////////////
+//
+// The following two functions give read access to _ri and _val
+// vectors (corresponding to one column).
+//
+/////////////////////////////////////////////////////////////////////
+
+const std::vector<unsigned int>& SpMat<T>::get_ri(unsigned int i) const
+{
+ if (i >= _n) throw SpMatException("SpMat::get_ri: Index out of range");
+ return(_ri[i]);
+}
+
+const std::vector<T>& SpMat<T>::get_val(unsigned int i) const
+{
+ if (i >= _n) throw SpMatException("SpMat::get_val: Index out of range");
+ return(_val[i]);
+}
+
/*###################################################################
##
## Here starts hidden functions
--
GitLab