/usr/include/scythestat/matrix_forward_iterator.h is in libscythestat-dev 1.0.2-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 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 | /*
* Scythe Statistical Library Copyright (C) 2000-2002 Andrew D. Martin
* and Kevin M. Quinn; 2002-present Andrew D. Martin, Kevin M. Quinn,
* and Daniel Pemstein. All Rights Reserved.
*
* This program is free software; you can redistribute it and/or
* modify under the terms of the GNU General Public License as
* published by Free Software Foundation; either version 2 of the
* License, or (at your option) any later version. See the text files
* COPYING and LICENSE, distributed with this source code, for further
* information.
* --------------------------------------------------------------------
* scythestat/matrix_forward_iterator.h
*
* Forward iterators for the matrix class.
*
*/
/*! \file matrix_forward_iterator.h
* \brief Definitions of STL-compliant forward iterators for the
* Matrix class.
*
* Contains definitions of const_matrix_forward_iterator,
* matrix_forward_iterator, and related operators. See a Standard
* Template Library reference, such as Josuttis (1999), for a full
* description of the capabilities of forward iterators.
*
* These iterators are templated on the type, order and style of the
* Matrix they iterate over and their own order, which need not match
* the iterated-over matrix. Same-order iteration over concrete
* matrices is extremely fast. Cross-grain concrete and/or view
* iteration is slower.
*/
#ifndef SCYTHE_MATRIX_FORWARD_ITERATOR_H
#define SCYTHE_MATRIX_FORWARD_ITERATOR_H
#include <iterator>
#ifdef SCYTHE_COMPILE_DIRECT
#include "defs.h"
#include "error.h"
#include "matrix.h"
#else
#include "scythestat/defs.h"
#include "scythestat/error.h"
#include "scythestat/matrix.h"
#endif
namespace scythe {
/* convenience typedefs */
namespace { // local to this file
typedef unsigned int uint;
}
/* forward declaration of the matrix class */
template <typename T_type, matrix_order ORDER, matrix_style STYLE>
class Matrix;
/*! \brief An STL-compliant const forward iterator for Matrix.
*
* Provides forward iteration over const Matrix objects. See
* Josuttis (1999), or some other STL reference, for a full
* description of the forward iterator interface.
*
* \see Matrix
* \see matrix_forward_iterator
* \see const_matrix_random_access_iterator
* \see matrix_random_access_iterator
* \see const_matrix_bidirectional_iterator
* \see matrix_bidirectional_iterator
*/
template <typename T_type, matrix_order ORDER, matrix_order M_ORDER,
matrix_style M_STYLE>
class const_matrix_forward_iterator
: public std::iterator<std::forward_iterator_tag, T_type>
{
public:
/**** TYPEDEFS ***/
typedef const_matrix_forward_iterator<T_type, ORDER,
M_ORDER, M_STYLE> self;
/* These are a little formal, but useful */
typedef typename std::iterator_traits<self>::value_type
value_type;
typedef typename std::iterator_traits<self>::iterator_category
iterator_category;
typedef typename std::iterator_traits<self>::difference_type
difference_type;
typedef typename std::iterator_traits<self>::pointer pointer;
typedef typename std::iterator_traits<self>::reference reference;
/**** CONSTRUCTORS ****/
/* Default constructor */
const_matrix_forward_iterator ()
{}
/* Standard constructor */
const_matrix_forward_iterator
(const Matrix<value_type, M_ORDER, M_STYLE> &M)
: pos_ (M.getArray()),
matrix_ (&M)
{
SCYTHE_CHECK_30 (pos_ == 0, scythe_null_error,
"Requesting iterator to NULL matrix");
/* The basic story is: when M_STYLE == Concrete and ORDER ==
* M_ORDER, we only need pos_ and iteration will be as fast as
* possible. All other types of iteration need more variables
* to keep track of things and are slower.
*/
if (M_STYLE != Concrete || M_ORDER != ORDER) {
offset_ = 0;
if (ORDER == Col) {
lead_length_ = M.rows();
lead_inc_ = M.rowstride();
trail_inc_ = M.colstride();
} else {
lead_length_ = M.cols();
lead_inc_ = M.colstride();
trail_inc_ = M.rowstride();
}
jump_ = trail_inc_ + (1 - lead_length_) * lead_inc_;
vend_ = pos_ + (lead_length_ - 1) * lead_inc_;
}
#if SCYTHE_DEBUG > 2
size_ = M.size();
start_ = pos_;
#endif
}
/* Copy constructor */
const_matrix_forward_iterator (const self &mi)
: pos_ (mi.pos_),
matrix_ (mi.matrix_)
{
if (M_STYLE != Concrete || M_ORDER != ORDER) {
offset_ = mi.offset_;
lead_length_ = mi.lead_length_;
lead_inc_ = mi.lead_inc_;
trail_inc_ = mi.trail_inc_;
vend_ = mi.vend_;
jump_ = mi.jump_;
}
#if SCYTHE_DEBUG > 2
size_ = mi.size_;
start_ = mi.start_;
#endif
}
/**** EXTRA MODIFIER ****/
/* This function lets us grab an end iterator quickly, for both
* concrete and view matrices. The view code is a bit of a
* kludge, but it works.
*/
inline self& set_end ()
{
if (M_STYLE == Concrete && ORDER == M_ORDER) {
pos_ = matrix_->getArray() + matrix_->size();
} else {
offset_ = matrix_->size();
}
return *this;
}
/* Returns the current index (in logical matrix terms) of the
* iterator.
*/
unsigned int get_index () const
{
return offset_;
}
/**** FORWARD ITERATOR FACILITIES ****/
inline self& operator= (const self& mi)
{
pos_ = mi.pos_;
matrix_ = mi.matrix_;
if (M_STYLE != Concrete || M_ORDER != ORDER) {
offset_ = mi.offset_;
lead_length_ = mi.lead_length_;
lead_inc_ = mi.lead_inc_;
trail_inc_ = mi.trail_inc_;
vend_ = mi.vend_;
jump_ = mi.jump_;
}
#if SCYTHE_DEBUG > 2
size_ = mi.size_;
start_ = mi.start_;
#endif
return *this;
}
inline const reference operator* () const
{
SCYTHE_ITER_CHECK_BOUNDS();
return *pos_;
}
inline const pointer operator-> () const
{
SCYTHE_ITER_CHECK_BOUNDS();
return pos_;
}
inline self& operator++ ()
{
if (M_STYLE == Concrete && ORDER == M_ORDER)
++pos_;
else {
if (pos_ == vend_) {
vend_ += trail_inc_;
pos_ += jump_;
} else {
pos_ += lead_inc_;
}
++offset_;
}
return *this;
}
inline self operator++ (int)
{
self tmp = *this;
++(*this);
return tmp;
}
/* == is only defined for iterators of the same template type
* that point to the same matrix. Behavior for any other
* comparison is undefined.
*
* Note that we have to be careful about iterator comparisons
* when working with views and cross-grain iterators.
* Specifically, we always have to rely on the offset value.
* Obviously, with <> checks pos_ can jump all over the place in
* cross-grain iterators, but also end iterators point to the
* value after the last in the matrix. In some cases, the
* equation in += and -= will actually put pos_ inside the
* matrix (often in an early position) in this case.
*/
inline bool operator== (const self& x) const
{
if (M_STYLE == Concrete && ORDER == M_ORDER) {
return pos_ == x.pos_;
} else {
return offset_ == x.offset_;
}
}
/* Again, != is only officially defined for iterators over the
* same matrix although the test will be trivially true for
* matrices that don't view the same data, by implementation.
*/
inline bool operator!= (const self &x) const
{
return !(*this == x);
}
protected:
/**** INSTANCE VARIABLES ****/
T_type* pos_; // pointer to current position in array
T_type *vend_; // pointer to end of current vector
uint offset_; // logical offset into matrix
// TODO Some of these can probably be uints
int lead_length_; // Logical length of leading dimension
int lead_inc_; // Memory distance between vectors in ldim
int trail_inc_; // Memory distance between vectors in tdim
int jump_; // Memory distance between end of one ldim vector and
// begin of next
// Pointer to the matrix we're iterating over. This is really
// only needed to get variables necessary to set the end.
// TODO Handle this more cleanly.
const Matrix<T_type, M_ORDER, M_STYLE>* matrix_;
// Size variable for range checking
#if SCYTHE_DEBUG > 2
uint size_; // Logical matrix size
T_type* start_; // Not normally needed, but used for bound check
#endif
};
/*! \brief An STL-compliant forward iterator for Matrix.
*
* Provides forward iteration over Matrix objects. See
* Josuttis (1999), or some other STL reference, for a full
* description of the forward iterator interface.
*
* \see Matrix
* \see const_matrix_forward_iterator
* \see const_matrix_random_access_iterator
* \see matrix_random_access_iterator
* \see const_matrix_bidirectional_iterator
* \see matrix_bidirectional_iterator
*/
template <typename T_type, matrix_order ORDER, matrix_order M_ORDER,
matrix_style M_STYLE>
class matrix_forward_iterator
: public const_matrix_forward_iterator<T_type, ORDER,
M_ORDER, M_STYLE>
{
/**** TYPEDEFS ***/
typedef matrix_forward_iterator<T_type, ORDER, M_ORDER,
M_STYLE> self;
typedef const_matrix_forward_iterator<T_type, ORDER,
M_ORDER, M_STYLE> Base;
public:
/* These are a little formal, but useful */
typedef typename std::iterator_traits<Base>::value_type
value_type;
typedef typename std::iterator_traits<Base>::iterator_category
iterator_category;
typedef typename std::iterator_traits<Base>::difference_type
difference_type;
typedef typename std::iterator_traits<Base>::pointer pointer;
typedef typename std::iterator_traits<Base>::reference reference;
/**** CONSTRUCTORS ****/
/* Default constructor */
matrix_forward_iterator ()
: Base ()
{}
/* Standard constructor */
matrix_forward_iterator (const Matrix<value_type, M_ORDER,
M_STYLE> &M)
: Base(M)
{}
/* Copy constructor */
matrix_forward_iterator (const self &mi)
: Base (mi)
{}
/**** EXTRA MODIFIER ****/
inline self& set_end ()
{
Base::set_end();
return *this;
}
/**** FORWARD ITERATOR FACILITIES ****/
/* We have to override a lot of these to get return values
* right.*/
inline self& operator= (const self& mi)
{
pos_ = mi.pos_;
matrix_ = mi.matrix_;
if (M_STYLE != Concrete || M_ORDER != ORDER) {
offset_ = mi.offset_;
lead_length_ = mi.lead_length_;
lead_inc_ = mi.lead_inc_;
trail_inc_ = mi.trail_inc_;
vend_ = mi.vend_;
jump_ = mi.jump_;
}
#if SCYTHE_DEBUG > 2
size_ = mi.size_;
start_ = mi.start_;
#endif
return *this;
}
inline reference operator* () const
{
SCYTHE_ITER_CHECK_BOUNDS();
return *pos_;
}
inline pointer operator-> () const
{
SCYTHE_ITER_CHECK_BOUNDS();
return pos_;
}
inline self& operator++ ()
{
Base::operator++();
return *this;
}
inline self operator++ (int)
{
self tmp = *this;
++(*this);
return tmp;
}
private:
/* Get handles to base members. It boggles the mind */
using Base::pos_;
using Base::vend_;
using Base::offset_;
using Base::lead_length_;
using Base::lead_inc_;
using Base::trail_inc_;
using Base::jump_;
using Base::matrix_;
#if SCYTHE_DEBUG > 2
using Base::size_;
using Base::start_;
#endif
};
} // namespace scythe
#endif /* SCYTHE_MATRIX_ITERATOR_H */
|