/usr/include/linbox/blackbox/compose.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 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 | /* linbox/blackbox/compose.h
* Copyright (C) 1999-2001 William J Turner,
* 2001 Bradford Hovinen
*
* Written by William J Turner <wjturner@math.ncsu.edu>,
* Bradford Hovinen <hovinen@cis.udel.edu>
*
* ========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========
*/
#ifndef __LINBOX_compose_H
#define __LINBOX_compose_H
#include "linbox/util/debug.h"
#include "linbox/linbox-config.h"
#include "linbox/blackbox/blackbox-interface.h"
#include "linbox/matrix/blas-matrix.h"
namespace LinBox
{
template <class _Blackbox1, class _Blackbox2 = _Blackbox1>
class Compose;
template <class _Blackbox1, class _Blackbox2 = _Blackbox1>
class ComposeOwner;
}
namespace LinBox
{
/**
* Blackbox of a product: \f$C = AB\f$, i.e \f$Cx \gets A(Bx)\f$.
* This is a class that multiplies two matrices by implementing an
* apply method that calls the apply methods of both of the consituent
* matrices, one after the other.
*
* This class, like the Black Box archetype from which it is derived,
* is templatized by the vector type to which the matrix is applied.
* Both constituent matrices must also use this same vector type.
* For specification of the blackbox members see \ref BlackboxArchetype.
*
* <b> Template parameter:</b> must meet the \ref Vector requirement.
\ingroup blackbox
*/
//@{
/// General case
template <class _Blackbox1, class _Blackbox2>
class Compose : public BlackboxInterface {
typedef Compose<_Blackbox1, _Blackbox2> Self_t;
public:
typedef _Blackbox1 Blackbox1;
typedef _Blackbox2 Blackbox2;
typedef typename Blackbox2::Field Field;
typedef typename Field::Element Element;
/** Constructor of C := A*B from blackbox matrices A and B.
* Build the product A*B of any two black box matrices of compatible dimensions.
* @pre <code>A.coldim() == B.rowdim()</code>.
* @param A blackbox
* @param B blackbox
*/
Compose (const Blackbox1 &A, const Blackbox2 &B) :
_A_ptr(&A), _B_ptr(&B)
{
// Rich Seagraves - "It seems VectorWrapper somehow
// became depricated. Makes the assumption that
// this vector type supports resize"
// VectorWrapper::ensureDim (_z, _A_ptr->coldim ());
_z.resize(_A_ptr->coldim());
}
/** Constructor of C := (*A_ptr)*(*B_ptr).
* This constructor creates a matrix that is a product of two black box
* matrices: A*B from pointers to them.
* @param A_ptr blackbox
* @param B_ptr blackbox
*/
Compose (const Blackbox1 *A_ptr, const Blackbox2 *B_ptr) :
_A_ptr(A_ptr), _B_ptr(B_ptr)
{
linbox_check (A_ptr != (Blackbox1 *) 0);
linbox_check (B_ptr != (Blackbox2 *) 0);
linbox_check (A_ptr->coldim () == B_ptr->rowdim ());
// VectorWrapper::ensureDim (_z, _A_ptr->coldim ());
_z.resize(_A_ptr->coldim());
}
/** Copy constructor.
* Copies the composed matrix (a small handle). The underlying two matrices
* are not copied.
* @param[in] Mat blackbox to copy.
*/
Compose (const Compose<Blackbox1, Blackbox2>& Mat) :
_A_ptr ( Mat._A_ptr), _B_ptr ( Mat._B_ptr)
//{ VectorWrapper::ensureDim (_z, _A_ptr->coldim ()); }
{
_z.resize(_A_ptr->coldim());
}
/// Destructor
~Compose () {}
/*- Virtual constructor.
* Required because constructors cannot be virtual.
* Make a copy of the BlackboxArchetype object.
* Required by abstract base class.
* @return pointer to new blackbox object
*/
#if 0
BlackboxArchetype<_Vector> *clone () const
{ return new Compose (*this); }
#endif
/** Matrix * column vector product.
* \f$ y \gets (A\cdot B)\cdot x\f$
* Applies B, then A.
* @return reference to vector y containing output.
* @param x constant reference to vector to contain input
* @param[out] y the result.
*/
template <class OutVector, class InVector>
inline OutVector& apply (OutVector& y, const InVector& x) const
{
if ((_A_ptr != 0) && (_B_ptr != 0)) {
_B_ptr->apply (_z, x);
_A_ptr->apply (y, _z);
}
return y;
}
/** row vector * matrix product.
* \f$ y \gets (A\cdot B)^t \cdot x\f$.
* Applies A^t then B^t.
* @return reference to vector y containing output.
* @param x constant reference to vector to contain input
* @param[out] y the result.
*/
template <class OutVector, class InVector>
inline OutVector& applyTranspose (OutVector& y, const InVector& x) const
{
if ((_A_ptr != 0) && (_B_ptr != 0)) {
_A_ptr->applyTranspose (_z, x);
_B_ptr->applyTranspose (y, _z);
}
return y;
}
template<typename _Tp1, typename _Tp2 = _Tp1>
struct rebind {
typedef ComposeOwner<
typename Blackbox1::template rebind<_Tp1>::other,
typename Blackbox2::template rebind<_Tp2>::other
> other;
void operator() (other & Ap, const Self_t& A)
{
typename Blackbox1::template rebind<_Tp1> () ( Ap.getLeftData(), *(A.getLeftPtr()));
typename Blackbox2::template rebind<_Tp2> () ( Ap.getRightData(), *(A.getRightPtr()));
}
};
/*- Retreive row dimensions of BlackBox matrix.
* This may be needed for applying preconditioners.
* Required by abstract base class.
* @return integer number of rows of black box matrix.
*/
/// The number of rows
size_t rowdim (void) const
{
if (_A_ptr != 0)
return _A_ptr->rowdim ();
else
return 0;
}
/*- Retreive column dimensions of BlackBox matrix.
* Required by abstract base class.
* @return integer number of columns of black box matrix.
*/
/// The number of columns
size_t coldim(void) const
{
if (_B_ptr != 0)
return _B_ptr->coldim ();
else
return 0;
}
/// The field.
const Field& field() const
{
return _B_ptr->field();
}
/// accessor to the blackboxes
const Blackbox1* getLeftPtr() const
{
return _A_ptr;
}
/// accessor to the blackboxes
const Blackbox2* getRightPtr() const
{
return _B_ptr;
}
protected:
// Pointers to A and B matrices
const Blackbox1 *_A_ptr;
const Blackbox2 *_B_ptr;
// local intermediate vector
mutable std::vector<Element> _z;
};
/// specialization for _Blackbox1 = _Blackbox2
template <class _Blackbox>
class Compose <_Blackbox, _Blackbox> : public BlackboxInterface {
typedef Compose<_Blackbox, _Blackbox> Self_t;
public:
typedef _Blackbox Blackbox;
typedef typename _Blackbox::Field Field;
typedef typename _Blackbox::Element Element;
Compose (const Blackbox& A, const Blackbox& B) {
_BlackboxL.push_back(&A);
_BlackboxL.push_back(&B);
_zl.resize(1);
_zl.front().resize (A.coldim());
}
Compose (const Blackbox* Ap, const Blackbox* Bp) {
_BlackboxL.push_back(Ap);
_BlackboxL.push_back(Bp);
_zl.resize(1);
_zl.front().resize (Ap ->coldim());
}
/** Constructor of C := A*B from blackbox matrices A and B.
* Build the product A*B of any two black box matrices of compatible dimensions.
* Requires A.coldim() equals B.rowdim().
*/
template<class BPVector>
Compose (const BPVector& v) :
_BlackboxL(v.begin(), v.end())
{
linbox_check(v.size() > 0);
_zl.resize(v.size() - 1);
typename std::vector<const Blackbox*>::iterator b_p;
typename std::vector<std::vector<Element> >::iterator z_p;
// it would be good to use just 2 vectors and flip/flop.
for ( b_p = _BlackboxL.begin(), z_p = _zl.begin();
z_p != _zl.end(); ++ b_p, ++ z_p)
z_p -> resize((*b_p) -> coldim());
}
~Compose () {}
template <class OutVector, class InVector>
inline OutVector& apply (OutVector& y, const InVector& x) const
{
typename std::vector<const Blackbox*>::const_reverse_iterator b_p;
typename std::vector<std::vector<Element> >::reverse_iterator z_p, pz_p;
b_p = _BlackboxL.rbegin();
pz_p = z_p = _zl.rbegin();
(*b_p) -> apply(*pz_p, x);
++ b_p; ++ z_p;
for (; z_p != _zl.rend(); ++ b_p, ++ z_p, ++ pz_p)
(*b_p) -> apply (*z_p,*pz_p);
(*b_p) -> apply(y, *pz_p);
return y;
}
/*! Application of BlackBox matrix transpose.
* <code>y= transpose(A*B)*x</code>.
* Requires one vector conforming to the \ref LinBox
* vector @link Archetypes archetype@endlink.
* Required by abstract base class.
* @return reference to vector y containing output.
* @param x constant reference to vector to contain input
* \param y result
*/
template <class OutVector, class InVector>
inline OutVector& applyTranspose (OutVector& y, const InVector& x) const
{
typename std::vector<const Blackbox*>::reverse_iterator b_p;
typename std::vector<std::vector<Element> >::reverse_iterator z_p, nz_p;
b_p = _BlackboxL.rbegin();
z_p = nz_p = _zl.rbegin();
(*b_p) -> applyTranspose (*z_p, x);
++ b_p; ++ nz_p;
for (; nz_p != _zl.rend(); ++ z_p, ++ nz_p, ++ b_p)
(*b_p) -> applyTranspose (*nz_p, *z_p);
(*b_p) -> applyTranspose (y, *z_p);
return y;
}
template<typename _Tp1>
struct rebind {
typedef Compose<typename Blackbox::template rebind<_Tp1>::other, typename Blackbox::template rebind<_Tp1>::other> other;
void operator() (other *& Ap, const Self_t& A) {
std::vector<typename other::Blackbox *> newPtrV;
typename std::vector<typename other::Blackbox *>::iterator np;
typename std::vector<const Blackbox* >::const_iterator bp;
for( bp = A._BlackboxL.begin(), np = newPtrV.begin();
bp != A._BlackboxL.end(); ++bp, ++np) {
typename Blackbox::template rebind<_Tp1> () (*np, *(*bp));
}
Ap = new other(newPtrV);
}
};
/*- Retreive row dimensions of BlackBox matrix.
* This may be needed for applying preconditioners.
* Required by abstract base class.
* @return integer number of rows of black box matrix.
*/
size_t rowdim (void) const
{
return _BlackboxL.front() -> rowdim();
}
/*- Retreive column dimensions of BlackBox matrix.
* Required by abstract base class.
* @return integer number of columns of black box matrix.
*/
size_t coldim(void) const
{
return _BlackboxL[_BlackboxL.size() - 1] -> coldim();
}
const Field& field() const
{return _BlackboxL.front() -> field();}
// accessors to the blackboxes
const Blackbox* getLeftPtr() const
{return _BlackboxL.front();}
const Blackbox* getRightPtr() const
{return _BlackboxL.back();}
protected:
// Pointers to A and B matrices
std::vector<const Blackbox*> _BlackboxL;
// local intermediate vector
mutable std::vector<std::vector<Element> > _zl;
};
//@}
} // namespace LinBox
// was compose-traits.h (by Zhendong Wan)
namespace LinBox
{
/// used in ..., for example
template<class IMatrix>
class ComposeTraits {
public:
typedef Compose<IMatrix, IMatrix> value_type;
};
/// used in smith-binary, for example
template<class Field>
class ComposeTraits< BlasMatrix<Field> > {
public:
// define the return value type
typedef BlasMatrix<Field> value_type;
};
}
namespace LinBox
{
/**
* Blackbox of a product: \f$C = AB\f$, i.e \f$Cx \gets A(Bx)\f$.
* This is a class that multiplies two matrices by implementing an
* apply method that calls the apply methods of both of the consituent
* matrices, one after the other.
*
* This class, like the Black Box archetype from which it is derived,
* is templatized by the vector type to which the matrix is applied.
* Both constituent matrices must also use this same vector type.
* For specification of the blackbox members see \ref BlackboxArchetype.
*
* <b> Template parameter:</b> must meet the \ref Vector requirement.
\ingroup blackbox
*/
//@{
/// General case
template <class _Blackbox1, class _Blackbox2>
class ComposeOwner : public BlackboxInterface {
typedef ComposeOwner<_Blackbox1, _Blackbox2> Self_t;
public:
typedef _Blackbox1 Blackbox1;
typedef _Blackbox2 Blackbox2;
typedef typename Blackbox2::Field Field;
typedef typename Field::Element Element;
/** Constructor of C := A*B from blackbox matrices A and B.
* Build the product A*B of any two black box matrices of compatible dimensions.
* Requires A.coldim() equals B.rowdim().
*/
ComposeOwner (const Blackbox1 &A, const Blackbox2 &B) :
_A_data(A), _B_data(B)
{
// Rich Seagraves - "It seems VectorWrapper somehow
// became depricated. Makes the assumption that
// this vector type supports resize"
// VectorWrapper::ensureDim (_z, _A_data.coldim ());
_z.resize(_A_data.coldim());
}
/** Constructor of C := (*A_data)*(*B_data).
* This constructor creates a matrix that is a product of two black box
* matrices: A*B from pointers to them.
*/
ComposeOwner (const Blackbox1 *A_data, const Blackbox2 *B_data) :
_A_data(*A_data), _B_data(*B_data)
{
linbox_check (A_data != (Blackbox1 *) 0);
linbox_check (B_data != (Blackbox2 *) 0);
linbox_check (A_data->coldim () == B_data->rowdim ());
// VectorWrapper::ensureDim (_z, _A_data.coldim ());
_z.resize(_A_data.coldim());
}
/** Copy constructor.
* Copies the composed matrix (a small handle). The underlying two matrices
* are not copied.
* \param M matrix to be copied.
*/
ComposeOwner (const ComposeOwner<Blackbox1, Blackbox2>& Mat) :
_A_data ( Mat.getLeftData()), _B_data ( Mat.getRightData())
{
_z.resize(_A_data.coldim());
}
/// Destructor
~ComposeOwner () {}
#if 0
/*- Virtual constructor.
* Required because constructors cannot be virtual.
* Make a copy of the BlackboxArchetype object.
* Required by abstract base class.
* @return pointer to new blackbox object
*/
BlackboxArchetype<_Vector> *clone () const
{
return new ComposeOwner (*this);
}
#endif
/** Matrix * column vector product.
* \f$ y= (A\cdot B) \cdot x.\f$
* Applies B, then A.
* @return reference to vector y containing output.
* @param x constant reference to vector to contain input
* \param y result
*/
template <class OutVector, class InVector>
inline OutVector& apply (OutVector& y, const InVector& x) const
{
return _A_data.apply (y, _B_data.apply (_z, x));
}
/** row vector * matrix product \f$y= (A \times B)^T \cdot x\f$.
* Applies A^t then B^t.
* @return reference to vector y containing output.
* @param x constant reference to vector to contain input
* @param y
*/
template <class OutVector, class InVector>
inline OutVector& applyTranspose (OutVector& y, const InVector& x) const
{
return _B_data.applyTranspose (y, _A_data.applyTranspose (_z, x));
}
template<typename _Tp1, typename _Tp2 = _Tp1>
struct rebind {
typedef ComposeOwner<
typename Blackbox1::template rebind<_Tp1>::other,
typename Blackbox2::template rebind<_Tp2>::other
> other;
void operator() (other & Ap, const Self_t& A) {
typename Blackbox1::template rebind<_Tp1> () ( Ap.getLeftData(), A.getLeftData());
typename Blackbox2::template rebind<_Tp2> () ( Ap.getRightData(), A.getRightData());
}
};
template<typename _BBt1, typename _BBt2, typename Field>
ComposeOwner (const Compose<_BBt1, _BBt2> &Mat, const Field& F) :
_A_data(*(Mat.getLeftPtr()), F),
_B_data(*(Mat.getRightPtr()), F),
_z(_A_data.coldim())
{
typename Compose<_BBt1, _BBt2>::template rebind<Field>()(*this,Mat);
}
template<typename _BBt1, typename _BBt2, typename Field>
ComposeOwner (const ComposeOwner<_BBt1, _BBt2> &Mat, const Field& F) :
_A_data(Mat.getLeftData(), F),
_B_data(Mat.getRightData(), F) ,
_z(_A_data.coldim())
{
typename ComposeOwner<_BBt1, _BBt2>::template rebind<Field>()(*this,Mat);
}
/*- Retreive row dimensions of BlackBox matrix.
* This may be needed for applying preconditioners.
* Required by abstract base class.
* @return integer number of rows of black box matrix.
*/
/// The number of rows
size_t rowdim (void) const
{
return _A_data.rowdim ();
}
/*- Retreive column dimensions of BlackBox matrix.
* Required by abstract base class.
* @return integer number of columns of black box matrix.
*/
/// The number of columns
size_t coldim(void) const
{
return _B_data.coldim ();
}
/// The field.
const Field& field() const
{return _B_data.field();}
// accessors to the blackboxes without ownership
const Blackbox1& getLeftData() const
{return _A_data;}
Blackbox1& getLeftData() {return _A_data;}
const Blackbox2& getRightData() const
{return _B_data;}
Blackbox2& getRightData() {return _B_data;}
protected:
// A and B matrices
Blackbox1 _A_data;
Blackbox2 _B_data;
// local intermediate vector
mutable std::vector<Element> _z;
};
}
#endif // __LINBOX_compose_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:
|