/usr/include/linbox/blackbox/sum.h is in liblinbox-dev 1.1.6~rc0-4.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 | /* -*- mode: C++; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* linbox/blackbox/sum.h
* Copyright (C) 2002 The LinBox group
*
* Time-stamp: <12 Jan 07 10:41:03 Jean-Guillaume.Dumas@imag.fr>
*
* ------------------------------------
*
* See COPYING for license information.
*/
#ifndef __SUM_H
#define __SUM_H
#include "linbox/vector/vector-domain.h"
#include "linbox/util/debug.h"
#include <linbox/blackbox/blackbox-interface.h>
// Namespace in which all LinBox library code resides
namespace LinBox
{
/** \brief blackbox of a matrix sum without copying.
\ingroup blackbox
* Adds only at apply time.
* Given two black boxes A and B of the same dimensions, form a black
* box representing A+B, i.e., Sum(A,B)x=(A+B)x=Ax+Bx
* @param Vector \ref{LinBox} dense or sparse vector of field elements
*/
template <class _Blackbox1, class _Blackbox2>
class Sum : public BlackboxInterface
{
typedef Sum<_Blackbox1, _Blackbox2> Self_t;
public:
typedef _Blackbox1 Blackbox1;
typedef _Blackbox2 Blackbox2;
typedef typename Blackbox1::Field Field;
typedef typename Blackbox1::Element Element;
/** Constructor from black box matrices.
* This constructor creates a matrix that is the sum,
* A + B, of black box matrices.
* @param A, B: black box matrices.
*/
Sum (const Blackbox1 &A, const Blackbox2 &B)
: _A_ptr(&A), _B_ptr(&B)
{
linbox_check (A.coldim () == B.coldim ());
linbox_check (A.rowdim () == B.rowdim ());
VectorWrapper::ensureDim (_z1, A.rowdim ());
VectorWrapper::ensureDim (_z2, A.coldim ());
}
/** Constructor from black box pointers.
* This constructor creates a matrix that is the sum,
* A + B, of black box matrices.
* @param A_ptr, B_ptr: pointers to black box matrices.
*/
Sum (const Blackbox1 *A_ptr, const Blackbox2 *B_ptr)
: _A_ptr(A_ptr), _B_ptr(B_ptr)
{
// create new copies of matrices in dynamic memory
linbox_check (A_ptr != 0);
linbox_check (B_ptr != 0);
linbox_check (A_ptr->coldim () == B_ptr->coldim ());
linbox_check (A_ptr->rowdim () == B_ptr->rowdim ());
VectorWrapper::ensureDim (_z1, A_ptr->rowdim ());
VectorWrapper::ensureDim (_z2, A_ptr->coldim ());
}
/** Copy constructor.
* Creates new black box objects in dynamic memory.
* @param M constant reference to compose black box matrix
*/
Sum (const Sum<Blackbox1, Blackbox2> &M)
: _A_ptr (M._A_ptr), _B_ptr (M._B_ptr)
{
VectorWrapper::ensureDim (_z1, _A_ptr->rowdim ());
VectorWrapper::ensureDim (_z2, _A_ptr->coldim ());
}
/// Destructor
~Sum (void)
{
}
/** Application of BlackBox matrix.
* y= (A+B)*x.
* Requires one vector conforming to the \ref{LinBox}
* vector {@link Archetypes archetype}.
* Required by abstract base class.
* @return reference to vector y containing output.
* @param x constant reference to vector to contain input
*/
template<class OutVector, class InVector>
inline OutVector &apply (OutVector &y, const InVector &x) const
{
if (_A_ptr != 0 && _B_ptr != 0) {
VectorDomain<Field> VD (field());
typename Field::Element one;
field().init (one, 1);
_A_ptr->apply (y, x);
_B_ptr->apply (_z1, x);
VD.axpyin (y, one, _z1);
}
return y;
}
/** Application of BlackBox matrix transpose.
* y= transpose(A+B)*x.
* Requires one vector conforming to the \ref{LinBox}
* vector {@link Archetypes archetype}.
* Required by abstract base class.
* @return reference to vector y containing output.
* @param x constant reference to vector to contain input
*/
template<class OutVector, class InVector>
inline OutVector &applyTranspose (OutVector &y, const InVector &x) const
{
if (_A_ptr != 0 && _B_ptr != 0) {
VectorDomain<Field> VD (field());
typename Field::Element one;
field().init (one, 1);
_A_ptr->applyTranspose (y, x);
_B_ptr->applyTranspose (_z2, x);
VD.axpyin (y, one, _z2);
}
return y;
}
template<typename _Tp1, typename _Tp2 = _Tp1>
struct rebind
{ typedef Sum<typename Blackbox1::template rebind<_Tp1>::other, typename Blackbox2::template rebind<_Tp2>::other> other;
void operator() (other *& Ap, const Self_t& A, const _Tp1& F) {
typename other::Blackbox1 * A1;
typename Blackbox1::template rebind<_Tp1> () ( A1, *(A._A_ptr), F);
typename other::Blackbox2 * A2;
typename Blackbox2::template rebind<_Tp1> () ( A2, *(A._B_ptr), F);
Ap = new other(*A1, *A2);
}
};
/** 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 _A_ptr->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 _A_ptr->coldim (); }
const Field& field() const { return _A_ptr -> field(); }
protected:
// use a copy of the input field for faster performance (no pointer dereference).
const Blackbox1 *_A_ptr;
const Blackbox2 *_B_ptr;
mutable std::vector<Element> _z1;
mutable std::vector<Element> _z2;
}; // template <Field, Vector> class Sum
} // namespace LinBox
#endif // __SUM_H
|