/usr/include/linbox/blackbox/triplesbb.h is in liblinbox-dev 1.3.2-1.1.
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 | /* linbox/blackbox/triplesbb.h
* Copyright (c) Linbox
* ========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========
* Written by Rich Seagraves <seagrave@cis.udel.edu>
* with mods by bds
*/
/** @file blackbox/triplesbb.h
* @ingroup blackbox
* @brief NO DOC
*/
#ifndef __LINBOX_triplesbb_H
#define __LINBOX_triplesbb_H
#include <algorithm>
using std::max;
#include "linbox/linbox-config.h"
#include "linbox/util/debug.h"
#include "linbox/util/field-axpy.h"
#include "linbox/blackbox/blackbox-interface.h"
#include "linbox/field/hom.h"
#include <vector>
namespace LinBox
{
/** \brief wrapper for NAG Sparse Matrix format.
*
\ingroup blackbox
* This class acts as a wrapper for a pre-existing NAGSparse Matrix.
* To be used for interface between LinBox and computer algebra systems such
* as Maple that can encode sparse matrices in the NAGSparse format
*/
template<class _Field>
class TriplesBB : public BlackboxInterface{
public:
typedef _Field Field;
typedef typename Field::Element Element;
typedef TriplesBB<Field> Self_t;
// Default constructor.
TriplesBB() {}
// Takes 3 vectors and copies(bad) them.
TriplesBB( Field F,
std::vector<Element> values,
std::vector<size_t> rowP,
std::vector<size_t> colP,
size_t rows,
size_t cols,
bool RowSortFlag = false,
bool ColSortFlag = false);
// Alternate constructor. Allows for use of addEntry operation.
TriplesBB(Field F, size_t rows, size_t cols, size_t reserve = 0);
~TriplesBB() {};
// Copy Constructor
TriplesBB(const TriplesBB<Field> &);
// Assignment operator for use in STL map
const TriplesBB<Field> & operator=(const TriplesBB<Field> & );
template<class OutVector, class InVector>
OutVector & apply(OutVector &, const InVector &) const; // y = Ax;
template<class OutVector, class InVector>
OutVector & applyTranspose(OutVector &, const InVector &) const; // y = ATx
size_t rowdim() const { return _rows; }
size_t coldim() const { return _cols; }
template<typename _Tp1>
struct rebind {
typedef TriplesBB<_Tp1> other;
void operator() (other & Ap, const Self_t& A, const _Tp1& F)
{
Hom <typename Self_t::Field, _Tp1> hom( A.field(), F);
typedef typename _Tp1::Element otherElt;
typedef typename std::vector<otherElt> othervec;
typedef typename std::vector<Element> selfvec;
typedef typename othervec::iterator otheriter;
typedef typename selfvec::const_iterator selfiter;
otheriter vp_p; selfiter v_p;
Ap._values.resize(A._values.size());
for (v_p = A._values.begin(), vp_p = Ap._values.begin();
v_p != A._values.end(); ++ v_p, ++ vp_p)
hom.image (*vp_p, *v_p);
}
};
template<typename _Tp1>
TriplesBB(const TriplesBB<_Tp1>& T, const Field& F) :
_field(F), _values(T.size()), _RowV(T.getRows()), _ColV(T.getCols()), _rows(T.rowdim()), _cols(T.coldim()), _faxpy(max(T.getRows(),T.getCols()), FieldAXPY<Field>(F)), _RowSortFlag(T.isRowSorted()), _ColSortFlag(T.isColSorted())
{}
/* Returns number of non-zero entries */
size_t size() const { return _values.size(); }
// Add entry function, element e is added in the i,j position. Zero based?
void addEntry(const Element & e, const size_t i, const size_t j);
const Field & field() const { return _field; }
/* Data accessors. Used to access the 3 vectors containing Matrix data
*/
const std::vector<Element> & getData() const { return _values; }
const std::vector<size_t> & getRows() const { return _RowV; }
const std::vector<size_t> & getCols() const { return _ColV; }
bool isRowSorted() { return _RowSortFlag; }
bool isColSorted() { return _ColSortFlag; }
protected:
Field _field; // The field used by this class
/// _values contains the nonzero elements of the BlackBox
std::vector<Element> _values;
/// _RowV & _ColV are vectors containing the row & column indices
std::vector<size_t> _RowV, _ColV;
/// The number of rows, columns
size_t _rows, _cols;
/* _apply is the generic apply utility funtion called by apply() and
* applyTranspose(). Walks through the non-zero elements of the Matrix and
* performs the proper calculation using a vector of FieldAxpy's
*/
template<class OutVector, class InVector>
void _apply(OutVector &, const InVector &, std::vector<size_t>::const_iterator, std::vector<size_t>::const_iterator) const;
/* STL vector of FieldAXPY objects. Supports delayed modding out, a feature
* which contributes a significant speed boost when performing apply &
* applyTranspose calculations over a field of multi-precision integers
*/
mutable std::vector<FieldAXPY<Field> > _faxpy;
/* Sort flag. Used by the sort function to determine whether a sort
* operation is needed. Also used by _apply for a slightly optimized
* apply operation. Note, "sorted" is considered sorted if the
* matrix is row-sorted, IE if the entries go row 1, row 1, row 1, row 2, row 2, etc
*/
bool _RowSortFlag, _ColSortFlag;
};
/* Constructor for the TriplesBB class. This is the constructor that is
* expected to be used. To use it, you must pass in a field element that
* will work over the data (F), pointers to the 3 arrays used by the NAGSparse
* format (values, rowP, colP), the number of rows and columns (rows and
* cols), the number of non-zero elements (NNz) and the ordering, which
* defaults to 0 (no ordering implied).
*/
template<class Field>
TriplesBB<Field>::TriplesBB(Field F,
std::vector<Element> values,
std::vector<size_t> RowV,
std::vector<size_t> ColV,
size_t rows,
size_t cols,
bool RowSortFlag,
bool ColSortFlag) :
_field(F), _values(values), _RowV(RowV), _ColV(ColV), _rows(rows), _cols(cols), _faxpy(max(rows,cols), FieldAXPY<Field>(F)), _RowSortFlag(RowSortFlag), _ColSortFlag(ColSortFlag)
{}
/* Better constructor that only takes the field, m, n and recommended
* reserve (optional arguement) for use with STL vector reserve option
* (reduce the number of memory management moves). Meant to be used in
* conjuction with the addEntry() method
*/
template<class Field>
TriplesBB<Field>::TriplesBB( Field F, size_t rows, size_t cols, size_t res):
_field(F), _rows(rows), _cols(cols), _faxpy( max(rows, cols), FieldAXPY<Field>(F)), _RowSortFlag(false), _ColSortFlag(false)
{
if(res != 0) {
_values.reserve(res);
_RowV.reserve(res);
_ColV.reserve(res);
}
}
template<class Field>
TriplesBB<Field>::TriplesBB(const TriplesBB<Field> &In) :
_faxpy( max(In._rows, In._cols), FieldAXPY<Field>(In._field)),
_field ( In._field ),
_values ( In._values ),
_RowV ( In._RowV ),
_ColV ( In._ColV ),
_rows ( In._rows ),
_cols ( In._cols ),
_RowSortFlag ( In._RowSortFlag ),
_ColSortFlag ( In._ColSortFlag )
{ }
template<class Field>
const TriplesBB<Field> & TriplesBB<Field>::operator=(const TriplesBB<Field> & rhs)
{
_field = rhs._field;
_values = rhs._values;
_RowV = rhs._RowV;
_ColV = rhs._ColV;
_rows = rhs._rows; _cols = rhs._cols;
_RowSortFlag = rhs._RowSortFlag;
_ColSortFlag = rhs._ColSortFlag;
_faxpy.resize(rhs._faxpy.size(), FieldAXPY<Field>(_field));
return *this;
}
template<class Field>
template<class OutVector, class InVector>
OutVector & TriplesBB<Field>::apply(OutVector & y, const InVector & x) const
{
_apply( y, x, _RowV.begin(), _ColV.begin() );
return y;
}
/* BlackBoxArchetype applyTranspose function. Performs the y = ATx, where
* y and x are vectors passed in applyTranspose(y,x), and A is the present
* Matrix. Returns a reference to y. As this is a tranpose calculation,
* the indexing is reversed, so y is indexed by the columns, while x is indexed
* by the rows. Thus, as in apply above, takes advantage of this fact by
* switching on the ordering.
*/
template<class Field>
template<class OutVector, class InVector>
OutVector & TriplesBB<Field>::applyTranspose(OutVector & y, const InVector & x) const
{
_apply( y, x, _ColV.begin(), _RowV.begin() );
return y;
}
template<class Field>
template<class OutVector, class InVector>
void TriplesBB<Field>::_apply(OutVector & y, const InVector & x, std::vector<size_t>::const_iterator i, std::vector<size_t>::const_iterator j) const
{
typename OutVector::iterator yp;
typename InVector::const_iterator xp;
typename Field::Element zero;
typename std::vector<Element>::const_iterator v;
typename std::vector<FieldAXPY<Field> >::iterator fa_i;
_field.init(zero,0);
for(fa_i = _faxpy.begin(); fa_i != _faxpy.end(); ++fa_i)
fa_i->assign(zero);
for( v = _values.begin(), fa_i = _faxpy.begin() - 1, xp = x.begin() - 1; v != _values.end(); ++i, ++j, ++v)
(fa_i + *i)->mulacc(*v, *(xp + *j));
for(fa_i = _faxpy.begin(), yp = y.begin(); yp != y.end(); ++yp, ++fa_i)
fa_i->get(*yp);
}
/* addEntry method. Allows user to add entries on the fly. Meant to be used
* with the "copyless" constructor above. Note, will automatically set the
* _sortFlag to false, as you can't be sure the entries are still sorted afterwards
*/
template<class Field>
void TriplesBB<Field>::addEntry(const Element &Elem, const size_t i, const size_t j)
{
_RowSortFlag = _ColSortFlag = false;
_values.push_back(Elem);
_RowV.push_back(i);
_ColV.push_back(j);
}
#if 0
template<class Field, class Vector>
void TriplesBB<Field, Vector>::SortByRow()
{
RowWiseLessThan<Field,Vector> rwlt;
if(_RowSortFlag) return; // If already sorted, bail
std::sort( IndexedBegin(), IndexedEnd(), rwlt );
_RowSortFlag = true; // Sets the row sort flag
_ColSortFlag = false; // Unset the col sort flag
}
template<class Field, class Vector>
void TriplesBB<Field, Vector>::SortByCol()
{
ColWiseLessThan<Field,Vector> cwlt;
if(_ColSortFlag) return; // If already sorted, bail
std::sort( IndexedBegin(), IndexedEnd(), cwlt );
_ColSortFlag = true; // Sets the Col sort flag
_RowSortFlag = false; // Unset the Row sort flag
}
#endif
} // namespace LinBox
#endif // __LINBOX_triplesbb_H
// vim:sts=8:sw=8:ts=8:noet:sr:cino=>s,f0,{0,g0,(0,:0,t0,+0,=s
// Local Variables:
// mode: C++
// tab-width: 8
// indent-tabs-mode: nil
// c-basic-offset: 8
// End:
|