/usr/include/linbox/vector/vector-traits.h is in liblinbox-dev 1.3.2-1.1build2.
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 539 540 541 542 543 | /* linbox/vector/vector-traits.h
* Copyright (C) 1999-2001 William J Turner,
* 2001-2002 Bradford Hovinen
*
* Written by William J Turner <wjturner@math.ncsu.edu>,
* Bradford Hovinen <hovinen@cis.udel.edu>
*
* ------------------------------------
* Modified by Dmitriy Morozov <linbox@foxcub.org>. May 27, 2002.
*
* Implemented the Rootbeer meeting changes. Made VectorTag parametrized
* and added typedef of those parameters to Traits. So now VectorCategory
* for each vector has a "reference" back to the VectorTrait of each specific
* vector (list of pairs, deque of pairs, etc.) through a typedef Trait. This
* allows for generic manipulation of all vectors and placing the
* vector-implementation dependent code into VectorTraits only - as is done now
* with the function sort.
*
* ========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/vector/vector-traits.h
* @ingroup vector
* @brief vector traits
* @details NO DOC
*/
#ifndef __LINBOX_vector_traits_H
#define __LINBOX_vector_traits_H
#include <vector> // STL vectors
#include <list> // STL lists
#include <deque> // STL deques
#include <utility> // STL pairs
#include <functional> // STL functions
#include <map> // STL maps
#include <algorithm> // STL algorithms
#include "linbox/field/archetype.h"
#include "linbox/field/rebind.h"
namespace LinBox
{
/** @name Vector traits.
* Vector traits are use to allow template specialization to choose different
* code for dense and sparse vectors.
\ingroup vector
*/
//@{
/** \brief List of vector categories.
* This structure contains three structures: one relating to dense vectors,
* one relating to sparse vectors implemented as sequences of pairs, and
* one relating to sparse vectors implemented as associative containers.
* These types allow us to use template specialization to use different
* code for different types of vectors.
*/
struct VectorCategories {
//! Generic vector (no assumption is made)
struct GenericVectorTag {
friend std::ostream& operator<< (std::ostream& o,
const GenericVectorTag& ) {
return o << "GenericVectorTag";
}
};
//! Sparse @ref GF2 vectors
struct SparseZeroOneVectorTag : public GenericVectorTag {
friend std::ostream& operator<< (std::ostream& o,
const SparseZeroOneVectorTag& ) {
return o << "SparseZeroOneVectorTag";
}
};
//! Dense vector (GF2 and general)
struct DenseVectorTag : public SparseZeroOneVectorTag {
// Inherits from SparseZeroOneVectorTag:
// This simplifies gf2 management of vectors
// and makes Dense vector also a generic vector
friend std::ostream& operator<< (std::ostream& o,
const DenseVectorTag& ) {
return o << "DenseVectorTag";
}
};
//! Sparse vectors (general)
struct SparseVectorTag : public GenericVectorTag {
friend std::ostream& operator<< (std::ostream& o,
const SparseVectorTag& ) {
return o << "SparseVectorTag";
}
};
//! Sparse vectors (general)
struct SparseSequenceVectorTag : public SparseVectorTag {
friend std::ostream& operator<< (std::ostream& o,
const SparseSequenceVectorTag& ) {
return o << "SparseSequenceVectorTag";
}
};
//! Sparse vectors (general)
struct SparseAssociativeVectorTag : public SparseVectorTag {
friend std::ostream& operator<< (std::ostream& o,
const SparseAssociativeVectorTag& ) {
return o << "SparseAssociativeVectorTag";
}
};
//! Sparse vectors (general)
struct SparseParallelVectorTag : public SparseVectorTag {
friend std::ostream& operator<< (std::ostream& o,
const SparseParallelVectorTag& ) {
return o << "SparseParallelVectorTag";
}
};
//! Sparse vectors (general)
struct DenseZeroOneVectorTag : public DenseVectorTag {
friend std::ostream& operator<< (std::ostream& o,
const DenseZeroOneVectorTag& ) {
return o << "DenseZeroOneVectorTag";
}
};
};
// Helper structure used for various STL's sorts (std::list::sort and std::stable_sort)
// for comparison of two pairs of elements (by their first elements)
template<class Element>
struct SparseSequenceVectorPairLessThan :
public std::binary_function<const std::pair<size_t, Element>&, const std::pair<size_t, Element>&, bool > {
bool operator() (const std::pair<size_t, Element>& p1, const std::pair<size_t, Element>& p2)
{
return p1.first < p2.first;
}
};
/** Vector traits template structure.
* By default, it tries to take all information from the vector class,
* but it cannot usually do this. For example, the vector_category
* type is not defined in STL types, so this must be done through
* template specialization.
* @tparam Vector \ref LinBox dense or sparse vector.
*/
template <class Vector>
struct VectorTraits {
typedef typename Vector::VectorCategory VectorCategory;
typedef Vector VectorType;
// These are defined for all STL vectors and sequence containers.
};
// Specialization for STL vectors
template <class Element>
struct VectorTraits< std::vector<Element> > {
typedef typename VectorCategories::DenseVectorTag VectorCategory;
typedef std::vector<Element> VectorType;
};
// Specialization for STL vectors of pairs of size_t and elements
template <class Element>
struct VectorTraits< std::vector< std::pair<size_t, Element> > > {
typedef typename VectorCategories::SparseSequenceVectorTag VectorCategory;
typedef std::vector< std::pair<size_t, Element> > VectorType;
static void sort (VectorType& v) { std::stable_sort(v.begin(), v.end(), SparseSequenceVectorPairLessThan<Element>()); }
};
// Specialization for STL lists of pairs of size_t and elements
template <class Element>
struct VectorTraits< std::list< std::pair<size_t, Element> > > {
typedef typename VectorCategories::SparseSequenceVectorTag VectorCategory;
typedef std::list< std::pair<size_t, Element> > VectorType;
static void sort (VectorType& v) { v.sort(SparseSequenceVectorPairLessThan<Element>()); }
};
// Specialization for STL singly linked lists of pairs of size_t and elements
template <class Element>
struct VectorTraits< std::deque< std::pair<size_t, Element> > >
{
typedef typename VectorCategories::SparseSequenceVectorTag VectorCategory;
typedef std::deque< std::pair<size_t, Element> > VectorType;
static void sort (VectorType& v) { std::stable_sort(v.begin, v.end(), SparseSequenceVectorPairLessThan<Element>()); }
};
// Specialization for STL maps of size_t and elements
template <class Element>
struct VectorTraits< std::map<size_t, Element> >
{
typedef typename VectorCategories::SparseAssociativeVectorTag VectorCategory;
typedef std::map<size_t, Element> VectorType;
};
// Specialization for an STL pair of an STL vector of size_t's and an STL vector of elements
template <class Element>
struct VectorTraits< std::pair<std::vector<size_t>, std::vector<Element> > >
{
typedef typename VectorCategories::SparseParallelVectorTag VectorCategory;
typedef std::pair<std::vector<size_t>, std::vector<Element> > VectorType;
};
// Namespace containing some useful generic functions
/// limited doc so far.
namespace VectorWrapper
{
template <class T>
class CompareSparseEntries {
public:
template<typename PairType>
inline bool operator () (const PairType &i, const size_t j) const
{
return i.first < j;
}
};
template <class Field, class Vector>
inline typename Field::Element &
refSpecialized (Vector &v, size_t i,
VectorCategories::DenseVectorTag)
{
return v[i];
}
template <class Field, class Vector>
inline typename Field::Element &
refSpecialized (Vector &v, size_t i,
VectorCategories::SparseSequenceVectorTag)
{
static typename Field::Element zero;
typename Vector::iterator j;
if (v.size () == 0) {
v.push_back (std::pair <size_t, typename Field::Element> (i, zero));
return v[0].second;
}
j = std::lower_bound (v.begin (), v.end (), i, CompareSparseEntries<typename Field::Element> ());
if (j == v.end () || j->first != i)
j = v.insert (j, std::pair <size_t, typename Field::Element> (i, zero));
return j->second;
}
template <class Field, class Vector>
inline typename Field::Element &
refSpecialized (Vector &v, size_t i,
VectorCategories::SparseAssociativeVectorTag)
{
return v[i];
}
template <class Field, class Vector>
inline typename Field::Element &
refSpecialized (Vector &v, size_t i,
VectorCategories::SparseParallelVectorTag)
{
static typename Field::Element zero;
typename Vector::first_type::iterator j_idx;
typename Vector::second_type::iterator j_elt;
if (v.first.size () == 0) {
v.first.push_back (i);
v.second.push_back (zero);
return v.second.front ();
}
j_idx = std::lower_bound (v.first.begin (), v.first.end (), i);
j_elt = v.second.begin () + (j_idx - v.first.begin ());
if (j_idx == v.first.end () || *j_idx != i) {
v.first.insert (j_idx, i);
j_elt = v.second.insert (j_elt, zero);
}
return *j_elt;
}
template <class Field, class Vector>
inline typename Field::Element &ref (Vector &v, size_t i)
{
return refSpecialized<Field, Vector> (v, i, typename VectorTraits<Vector>::VectorCategory());
}
template <class Field, class Vector>
inline const typename Field::Element &
constRefSpecialized (Vector &v, size_t i,
VectorCategories::DenseVectorTag)
{
return v[i];
}
template <class Field, class Vector>
inline const typename Field::Element &
constRefSpecialized (Vector &v, size_t i,
VectorCategories::SparseSequenceVectorTag)
{
static typename Field::Element zero;
typename Vector::const_iterator j;
if (v.size () == 0)
return zero;
j = std::lower_bound (v.begin (), v.end (), i, CompareSparseEntries<typename Field::Element> ());
if (j == v.end () || j->first != i)
return zero;
else
return j->second;
}
template <class Field, class Vector>
inline const typename Field::Element &
constRefSpecialized (Vector &v, size_t i,
VectorCategories::SparseAssociativeVectorTag)
{
return v[i];
}
template <class Field, class Vector>
inline typename Field::Element &
constRefSpecialized (Vector &v, size_t i,
VectorCategories::SparseParallelVectorTag)
{
static typename Field::Element zero;
typename Vector::first_type::iterator j_idx;
typename Vector::second_type::iterator j_elt;
if (v.first.size () == 0)
return zero;
j_idx = std::lower_bound (v.first.begin (), v.first.end (), i);
if (j_idx == v.first.end () || *j_idx != i)
return zero;
else {
j_elt = v.second.begin () + (j_idx - v.first.begin ());
return *j_elt;
}
}
template <class Vector>
inline void ensureDimSpecialized (Vector &v, size_t n,
VectorCategories::DenseZeroOneVectorTag)
{
v.resize (n);
}
template <class Vector>
inline void ensureDimSpecialized (Vector &v, size_t n,
VectorCategories::SparseZeroOneVectorTag)
{}
template <class Field, class Vector>
inline const typename Field::Element &constRef (Vector &v, size_t i)
{
return constRefSpecialized<Field, Vector> (v, i, typename VectorTraits<Vector>::VectorCategory());
}
template <class Vector>
inline void ensureDimSpecialized (Vector &v, size_t n,
VectorCategories::DenseVectorTag)
{
v.resize (n);
}
template <class Vector>
inline void ensureDimSpecialized (Vector &v, size_t n,
VectorCategories::SparseSequenceVectorTag)
{}
template <class Vector>
inline void ensureDimSpecialized (Vector &v, size_t n,
VectorCategories::SparseAssociativeVectorTag)
{}
template <class Vector>
inline void ensureDimSpecialized (Vector &v, size_t n,
VectorCategories::SparseParallelVectorTag)
{}
template <class Vector>
inline void ensureDim (Vector &v, size_t n)
{
ensureDimSpecialized (v, n, typename VectorTraits<Vector>::VectorCategory());
}
} // Namespace VectorWrapper
// Now we create some "canonical" vector types, so that users don't
// always have to typedef everything
/** Canonical vector types
*
* This class includes some typedefs that avoid the necessity to typedef
* the vector type whenever it is used. In a typical case, one would say
* Vector<Field>::Dense for a dense vector and Vector<Field>::Sparse for
* a sparse vector.
*/
template <class Element>
struct RawVector {
typedef std::vector<Element> Dense;
typedef std::pair<std::vector<size_t>, std::vector<Element> > Sparse;
typedef std::vector<std::pair<size_t, Element> > SparseSeq;
typedef std::map<size_t, Element> SparseMap;
typedef std::pair<std::vector<size_t>, std::vector<Element> > SparsePar;
template<class VType> static size_t size(const VType& d)
{
return d.size();
}
static size_t size(const Sparse& d)
{
return d.first.size();
}
// static size_t size(const SparsePar& d) { return d.first.size(); }
template<class VType>
static VType& convert(VType& u, const VType& v)
{
return u = v;
}
static Dense& convert(Dense& u, const SparseSeq& v)
{
for(typename SparseSeq::const_iterator sit = v.begin(); sit != v.end(); ++sit) {
if (sit->first > u.size()) u.resize(sit->first);
u[sit->first] = sit->second;
}
return u;
}
static Sparse& convert(Sparse& u, const SparseSeq& v)
{
u.first.resize(v.size());
u.second.resize(v.size());
typename SparseSeq::const_iterator ssit = v.begin();
std::vector<size_t>::iterator vit = u.first.begin();
typename std::vector<Element>::iterator eit = u.second.begin();
for(; ssit != v.end(); ++ssit, ++vit, ++eit) {
*vit = ssit->first;
*eit = ssit->second;
}
return u;
}
static SparseSeq& convert(SparseSeq& u, const Sparse& v)
{
u.resize(v.first.size());
typename SparseSeq::iterator ssit = u.begin();
std::vector<size_t>::const_iterator vit = v.first.begin();
typename std::vector<Element>::const_iterator eit = v.second.begin();
for(; ssit != u.end(); ++ssit, ++vit, ++eit) {
ssit->first = *vit;
ssit->second = *eit;
}
return u;
}
//! @todo : other convertions
};
//! Vector ??
template <class Ring>
struct Vector : public RawVector<typename Ring::Element> {
typedef typename Ring::Element Element;
template<class U>
struct rebind {
typedef Vector<U> other;
};
};
//! Rebind
//@{
template<class T, class U>
struct Rebind< std::vector<T>, U > {
typedef typename Vector<U>::Dense other;
};
template<class T, class U>
struct Rebind< std::pair<std::vector<size_t>, std::vector<T> >,U > {
typedef typename Vector<U>::Sparse other;
};
template<class T, class U>
struct Rebind< std::vector<std::pair<size_t, T> >, U > {
typedef typename Vector<U>::SparseSeq other;
};
template<class T, class U>
struct Rebind< std::map<size_t, T>, U > {
typedef typename Vector<U>::SparseMap other;
};
//@} Rebind
//@} Vector traits
} // namespace LinBox
#endif // __LINBOX_vector_traits_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:
|