/usr/include/linbox/matrix/sparsematrix/sparse-generic.h is in liblinbox-dev 1.4.2-5build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 | /* linbox/matrix/sparse-matrix.h
* Copyright (C) 2001-2002 Bradford Hovinen
* 1999-2001 William J Turner,
*
* Written by William J Turner <wjturner@math.ncsu.edu>,
* Bradford Hovinen <hovinen@cis.udel.edu>
*
* --------------------------------------------------------
* 2003-01-11 Bradford Hovinen <bghovinen@math.uwaterloo.ca>
*
* Move from blackbox/sparse-base.h to matrix/sparse-matrix.h
* ------------------------------------
* 2002-11-28 Bradford Hovinen <bghovinen@math.uwaterloo.ca>
*
* - Renamed ColOfRowsIterator to RowIterator
* - Named template argument _Row rather than Row; add a typedef to Row
* - Named template argument _Element rather than Row; add a typedef to Element
* - Renamed IndexIterator as IndexedIterator, and adjusted to match
* interface in DenseMatrixBase
* ------------------------------------
* 2002-08-06 Bradford Hovinen <hovinen@cis.udel.edu>
*
* Renamed to sparse-base.h from sparse0-base.h
* ------------------------------------
* Modified by Bradford Hovinen <hovinen@cis.udel.edu>
*
* Refactoring:
* - Eliminated SparseMatrixAux and moved that functionality into Sparse0
* - Made SparseMatrixGeneric parameterized only on the element type
* - New read/write implementations for SparseMatrixGeneric, supporting multiple
* formats
* - Eliminated Gaussian elimination code
* - Added iterators, including ColOfRowsIterator, Iterator, and
* IndexIterator
* - Eliminated operator []; added getEntry; changed put_value to setEntry
* ------------------------------------
*
*
* ========LICENCE========
* This file is part of the library LinBox.
*
* LinBox is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* ========LICENCE========
*.
*/
/** @file linbox/matrix/sparsematrix/sparse-generic.h
* @brief
*/
#ifndef __LINBOX_matrix_sparsematrix_sparse_generic_H
#define __LINBOX_matrix_sparsematrix_sparse_generic_H
#ifndef _SP_BB_VECTOR_
#include <vector>
#define _SP_BB_VECTOR_ std::vector
#endif
#include <utility>
#include <iostream>
#include <algorithm>
#include "linbox/linbox-config.h"
#include "linbox/util/debug.h"
#include "linbox/linbox-tags.h"
#include "linbox/matrix/sparse-formats.h"
#include "linbox/matrix/matrix-domain.h"
#include "linbox/matrix/transpose-matrix.h"
#include "linbox/vector/vector-traits.h"
#include "linbox/util/matrix-stream.h"
#include "linbox/solutions/solution-tags.h"
#include "linbox/matrix/matrix-traits.h"
#include "linbox/field/hom.h"
namespace LinBox { /* forward declarations */
template<class Field>
class MatrixDomain ;
} // LinBox
namespace LinBox { namespace Protected { /* SparseMatrixGeneric defaults */
template <class _Field,
class _Row = typename RawVector<typename _Field::Element>::Sparse,
class Trait = typename VectorTraits<_Row>::VectorCategory >
class SparseMatrixGeneric;
} // Protected
} // LinBox
namespace LinBox { /* read write helper */
template<class Matrix>
class SparseMatrixWriteHelper ;
template<class Matrix>
class SparseMatrixReadHelper ;
} // LinBox
namespace LinBox { namespace Protected { /* SparseMatrixGeneric */
/** Sparse matrix container
* This class acts as a generic row-wise container for sparse
* matrices. It is designed to provide various methods to access the
* entries of the matrix.
* It meets the blackbox archetype
* @tparam _Field Field type
* @tparam _Row LinBox sparse vector type to use for rows of matrix
\ingroup matrix
*/
template <class _Field, class _Row, class Trait>
class SparseMatrixGeneric {
public:
typedef _Field Field;
typedef typename Field::Element Element;
typedef _Row Row;
typedef const Row ConstRow;
typedef typename _SP_BB_VECTOR_<Row> Rep;
typedef SparseMatrixGeneric<_Field, _Row, Trait> Self_t;
#ifdef __LINBOX_PARALLEL
BB_list_list sub_list;
#endif
/** Constructor.
* Note: the copy constructor and operator= will work as intended
* because of STL's container design
* @param m row dimension
* @param n column dimension
*/
SparseMatrixGeneric (const Field & F,size_t m, size_t n) :
_field (F),
_MD(F),_AT(*this),
_matA(m), _m(m), _n(n)
{};
SparseMatrixGeneric (const Field & F) :
_field (F),
_MD(F),_AT(*this),
_matA(0), _m(0), _n(0)
{};
/** Constructor from a MatrixStream
*/
SparseMatrixGeneric ( MatrixStream<Field>& ms );
/** Copy constructor.
*/
SparseMatrixGeneric (const SparseMatrixGeneric<Field, Row, Trait> &A);
/** Convert constructor.
*/
template<class VectorType>
SparseMatrixGeneric (const SparseMatrixGeneric<Field, VectorType, Trait> &A);
template<typename _Tp1, typename _R1 = typename Rebind<_Row,_Tp1>::other >
struct rebind {
typedef SparseMatrixGeneric<_Tp1, _R1> other;
void operator() (other & Ap, const Self_t& A) {
typename _Tp1::Element e;
Hom<typename Self_t::Field, _Tp1> hom(A.field(), Ap.field());
for( typename Self_t::ConstIndexedIterator
indices = A.IndexedBegin();
indices != A.IndexedEnd() ;
++indices ) {
hom. image (e, indices.value() );
if (!Ap.field().isZero(e))
Ap.setEntry (indices.rowIndex(),
indices.colIndex(), e);
}
}
};
template<typename _Tp1, typename _Rw1, typename _myT>
SparseMatrixGeneric (const SparseMatrixGeneric<_Tp1, _Rw1, _myT> &Mat, const Field& F) :
_field (&F),
_MD (F), _AT (*this)
, _matA (Mat.rowdim()), _m (Mat.rowdim()), _n (Mat.coldim())
{
typename SparseMatrixGeneric<_Tp1,_Rw1, _myT>::template rebind<Field,_Row>()(*this, Mat);
}
template<class VectStream>
SparseMatrixGeneric (const Field &F, VectStream &stream) :
_field (F), _MD (F), _AT (*this)
, _matA (stream.size()), _m (stream.size()), _n (stream.dim())
{
typename Self_t::RowIterator i;
for (i = Self_t::rowBegin (); i != Self_t::rowEnd (); ++i)
stream >> *i;
}
/** Destructor. */
~SparseMatrixGeneric () {
#ifdef __LINBOX_PARALLEL
BB_list_list::iterator p;
BB_list::iterator e_p;
for (p = sub_list. begin(); p != sub_list. end(); ++ p)
for (e_p = p -> second. begin();
e_p != p -> second. end(); ++ e_p) {
Thread::terminate_thread (*e_p);
delete (*e_p);
}
#endif
}
/** Retreive row dimension of the matrix.
* @return integer number of rows of SparseMatrixGeneric matrix.
*/
size_t rowdim () const
{
return _m;
}
/** Retreive column dimension of matrix.
* @return integer number of columns of SparseMatrixGeneric matrix.
*/
size_t coldim () const
{
return _n;
}
/** Retreive number of elements in the matrix.
* @return integer number of elements of SparseMatrixGeneric matrix.
* @bug should it be elements or non zero elements ? @see ELL
*/
size_t size () const
{
size_t s(0);
for(typename Rep::const_iterator it = _matA.begin(); it != _matA.end(); ++it)
s+= LinBox::RawVector<Element>::size(*it);
return s;
}
/** Read a matrix from the given input stream using field read/write
* @param is Input stream from which to read the matrix
* @param format Format of input matrix
*/
std::istream &read (std::istream &is, LINBOX_enum(Tag::FileFormat) format = Tag::FileFormat::Detect );
/** Write a matrix to the given output stream using field read/write
* @param os Output stream to which to write the matrix
* @param F Field with which to write
* @param format Format with which to write
*/
std::ostream &write (std::ostream &os, LINBOX_enum(Tag::FileFormat) format = Tag::FileFormat::MatrixMarket) const;
/** Set an individual entry
* Setting the entry to 0 will remove it from the matrix
* @param i Row index of entry
* @param j Column index of entry
* @param value Value of the new entry
*/
void setEntry (size_t i, size_t j, const Element &value);
void appendEntry(size_t i, size_t j, const Element & value) { setEntry(i,j,value) ;}
void finalize(){}
/** Get a writeable reference to an entry in the matrix
* If there is no entry at the position (i, j), then a new entry
* with a value of zero is inserted and a reference to it is
* returned.
* @param i Row index of entry
* @param j Column index of entry
* @return Reference to matrix entry
*/
Element &refEntry (size_t i, size_t j);
/** Get a read-only individual entry from the matrix
* @param i Row index
* @param j Column index
* @return Const reference to matrix entry
*/
const Element &getEntry (size_t i, size_t j) const;
/** Get an entry and store it in the given value
* This form is more in the Linbox style and is provided for interface
* compatibility with other parts of the library
* @param x Element in which to store result
* @param i Row index
* @param j Column index
* @return Reference to x
*/
Element &getEntry (Element &x, size_t i, size_t j) const;
/** @name Columns of rows iterator
* The columns of row iterator gives each of the rows of the
* matrix in ascending order. Dereferencing the iterator yields
* a row vector in sparse sequence format
*/
typedef typename Rep::iterator RowIterator;
typedef typename Rep::const_iterator ConstRowIterator;
RowIterator rowBegin ();
RowIterator rowEnd ();
ConstRowIterator rowBegin () const;
ConstRowIterator rowEnd () const;
/** @name Raw iterator
* The raw iterator is a method for accessing all nonzero
* entries in the matrix in some unspecified order. This can be
* used, e.g. to reduce all matrix entries modulo a prime before
* passing the matrix into an algorithm.
*/
class Iterator;
class ConstIterator;
/// Begin.
Iterator Begin ();
/// End.
Iterator End ();
/// const Begin.
ConstIterator Begin () const;
/// const End
ConstIterator End () const;
/** @name Index iterator
* The index iterator gives the row, column indices of all matrix
* elements in the same order as the raw iterator above. Its value type
* is an STL pair with the row and column indices, starting at 0, in the
* first and second positions, respectively.
*/
class IndexedIterator;
class ConstIndexedIterator;
/// IndexedBegin
IndexedIterator IndexedBegin ();
/// IndexedEnd
IndexedIterator IndexedEnd ();
/// const IndexedBegin
ConstIndexedIterator IndexedBegin () const;
/// const IndexedEnd
ConstIndexedIterator IndexedEnd () const;
/** Retrieve a row as a writeable reference
* @param i Row index
*/
Row &getRow (size_t i);
/** Retrieve a row as a writeable reference.
* @param i Row index
*/
Row &operator [] (size_t i);
/** Retrieve a row as a read-only reference.
* @param i Row index
*/
ConstRow &operator [] (size_t i) const;
/** Compute the column density, i.e the number of entries per column.
* @param v Vector in which to store column density
*/
template <class Vector>
Vector &columnDensity (Vector &v) const;
/** Construct the transpose of this matrix and place it in the
* matrix given.
* @param AT
*/
SparseMatrixGeneric &transpose (SparseMatrixGeneric &AT) const;
const Field & field() const
{
return _field;
}
/** Matrix-vector product
* \f$y = A x\f$.
* @return reference to output vector y
* @param x input vector
* @param y
*/
template <class OutVector, class InVector>
OutVector &apply (OutVector &y, const InVector &x) const
{
#ifdef __LINBOX_PARALLEL
return BlackboxParallel (y, *this, x, BBBase::Apply);
#else
return _MD.vectorMul (y, *this, x);
#endif
}
/** Transpose matrix-vector product
* \f$ y = A^T x\f$.
* @return reference to output vector y
* @param x input vector
* @param y
*/
template <class OutVector, class InVector>
OutVector &applyTranspose (OutVector& y, const InVector &x) const
{
#ifdef __LINBOX_PARALLEL
return BlackboxParallel (y, *this, x, BBBase::ApplyTranspose);
#else
return _MD.vectorMul (y, _AT, x);
#endif
}
const Rep & getRep() const
{
return _matA;
}
Rep & refRep()
{
return _matA;
}
void resize( const size_t & m, const size_t & n, const size_t & z = 0)
{
_m = m ;
_n = n ;
_matA.clear();
_matA.resize(m);
}
protected:
friend class SparseMatrixWriteHelper<Self_t >;
friend class SparseMatrixReadHelper<Self_t >;
Rep _matA;
size_t _m;
size_t _n;
const Field & _field;
MatrixDomain<Field> _MD; // Matrix domain for matrix operations
TransposeMatrix<SparseMatrixGeneric<_Field, _Row> > _AT;
// template<class F, class R, class T> friend class SparseMatrixGeneric;
};
} // Protected
} // Linbox
#include "linbox/matrix/sparsematrix/sparse-sequence-vector.h"
#include "linbox/matrix/sparsematrix/sparse-parallel-vector.h"
#include "linbox/matrix/sparsematrix/sparse-associative-vector.h"
#include "linbox/matrix/sparsematrix/sparse-generic.inl"
namespace LinBox { /* IO / Traits */
template <class Field, class Row>
std::ostream &operator << (std::ostream &os, const Protected::SparseMatrixGeneric<Field, Row> &A)
{
return A.write (os);
}
template <class Field, class Row>
std::istream &operator >> (std::istream &is, Protected::SparseMatrixGeneric<Field, Row> &A)
{
return A.read (is);
}
template <class Field, class Row, class Trait>
struct MatrixTraits< Protected::SparseMatrixGeneric<Field, Row, Trait> >
{
typedef Protected::SparseMatrixGeneric<Field, Row, Trait> MatrixType;
typedef typename MatrixCategories::RowMatrixTag MatrixCategory;
};
template <class Field, class Row, class Trait>
struct MatrixTraits< const Protected::SparseMatrixGeneric<Field, Row, Trait> >
{
typedef const Protected::SparseMatrixGeneric<Field, Row, Trait> MatrixType;
typedef typename MatrixCategories::RowMatrixTag MatrixCategory;
};
template<class A, class B, class C>
struct GetEntryCategory<Protected::SparseMatrixGeneric<A,B,C> > {
typedef SolutionTags::Local Tag;
} ;
template <class Field, class _Row>
struct MatrixTraits< Protected::SparseMatrixGeneric<Field, _Row> >
{
typedef Protected::SparseMatrixGeneric<Field, _Row> MatrixType;
typedef MatrixCategories::RowMatrixTag MatrixCategory;
};
template<class A, class B>
struct GetEntryCategory<Protected::SparseMatrixGeneric<A,B> >
{
typedef SolutionTags::Local Tag;
};
} // namespace LinBox
#endif // __LINBOX_matrix_sparsematrix_sparse_generic_H
// Local Variables:
// mode: C++
// tab-width: 8
// indent-tabs-mode: nil
// c-basic-offset: 8
// End:
// vim:sts=8:sw=8:ts=8:noet:sr:cino=>s,f0,{0,g0,(0,\:0,t0,+0,=s
|