/usr/include/dolfin/la/uBLASVector.h is in libdolfin1.0-dev 1.0.0-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 | // Copyright (C) 2006-2010 Garth N. Wells
//
// This file is part of DOLFIN.
//
// DOLFIN 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 3 of the License, or
// (at your option) any later version.
//
// DOLFIN 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 DOLFIN. If not, see <http://www.gnu.org/licenses/>.
//
// Modified by Anders Logg, 2006-2010.
// Modified by Kent-Andre Mardal, 2008.
// Modified by Ola Skavhaug, 2008.
// Modified by Martin Alnæs, 2008.
//
// First added: 2006-03-04
// Last changed: 2011-01-14
#ifndef __UBLAS_VECTOR_H
#define __UBLAS_VECTOR_H
#include <boost/shared_ptr.hpp>
#include "ublas.h"
#include "GenericVector.h"
namespace dolfin
{
namespace ublas = boost::numeric::ublas;
template<typename T> class Array;
/// This class provides a simple vector class based on uBLAS.
/// It is a simple wrapper for a uBLAS vector implementing the
/// GenericVector interface.
///
/// The interface is intentionally simple. For advanced usage,
/// access the underlying uBLAS vector and use the standard
/// uBLAS interface which is documented at
/// http://www.boost.org/libs/numeric/ublas/doc/index.htm.
class uBLASVector : public GenericVector
{
public:
/// Create empty vector
uBLASVector();
/// Create vector of size N
explicit uBLASVector(uint N);
/// Copy constructor
uBLASVector(const uBLASVector& x);
/// Construct vector from a ublas_vector
explicit uBLASVector(boost::shared_ptr<ublas_vector> x);
/// Destructor
virtual ~uBLASVector();
//--- Implementation of the GenericTensor interface ---
/// Return true if tensor is distributed
virtual bool distributed() const
{ return false; }
/// Create copy of tensor
virtual uBLASVector* copy() const;
/// Set all entries to zero and keep any sparse structure
virtual void zero();
/// Finalize assembly of tensor
virtual void apply(std::string mode);
/// Return informal string representation (pretty-print)
virtual std::string str(bool verbose) const;
//--- Implementation of the GenericVector interface ---
/// Resize vector to size N
virtual void resize(uint N);
/// Resize vector with given ownership range
virtual void resize(std::pair<uint, uint> range);
/// Resize vector with given ownership range and with ghost values
virtual void resize(std::pair<uint, uint> range,
const std::vector<uint>& ghost_indices);
/// Return size of vector
virtual uint size() const;
/// Return local size of vector
virtual uint local_size() const
{ return size(); }
/// Return local ownership range of a vector
virtual std::pair<uint, uint> local_range() const;
/// Determine whether global vector index is owned by this process
virtual bool owns_index(uint i) const;
/// Get block of values
virtual void get_local(double* block, uint m, const uint* rows) const;
/// Set block of values
virtual void set(const double* block, uint m, const uint* rows);
/// Add block of values
virtual void add(const double* block, uint m, const uint* rows);
/// Get all values on local process
virtual void get_local(Array<double>& values) const;
/// Set all values on local process
virtual void set_local(const Array<double>& values);
/// Add values to each entry on local process
virtual void add_local(const Array<double>& values);
/// Gather entries into local vector x
virtual void gather(GenericVector& x, const Array<uint>& indices) const;
/// Gather entries into Array x
virtual void gather(Array<double>& x, const Array<uint>& indices) const;
/// Gather all entries into Array x on process 0
virtual void gather_on_zero(Array<double>& x) const;
/// Add multiple of given vector (AXPY operation)
virtual void axpy(double a, const GenericVector& x);
/// Replace all entries in the vector by their absolute values
virtual void abs();
/// Return inner product with given vector
virtual double inner(const GenericVector& x) const;
/// Compute norm of vector
virtual double norm(std::string norm_type) const;
/// Return minimum value of vector
virtual double min() const;
/// Return maximum value of vector
virtual double max() const;
/// Return sum of values of vector
virtual double sum() const;
/// Return sum of selected rows in vector. Repeated entries are only summed once.
virtual double sum(const Array<uint>& rows) const;
/// Multiply vector by given number
virtual const uBLASVector& operator*= (double a);
/// Multiply vector by another vector pointwise
virtual const uBLASVector& operator*= (const GenericVector& x);
/// Divide vector by given number
virtual const uBLASVector& operator/= (double a);
/// Add given vector
virtual const uBLASVector& operator+= (const GenericVector& x);
/// Subtract given vector
virtual const uBLASVector& operator-= (const GenericVector& x);
/// Assignment operator
virtual const GenericVector& operator= (const GenericVector& x);
/// Assignment operator
virtual const uBLASVector& operator= (double a);
/// Return pointer to underlying data (const version)
virtual const double* data() const
{ return &x->data()[0]; }
/// Return pointer to underlying data
virtual double* data()
{ return &x->data()[0]; }
//--- Special functions ---
/// Return linear algebra backend factory
virtual LinearAlgebraFactory& factory() const;
//--- Special uBLAS functions ---
/// Return reference to uBLAS vector (const version)
const ublas_vector& vec() const
{ return *x; }
/// Return reference to uBLAS vector (non-const version)
ublas_vector& vec()
{ return *x; }
/// Access value of given entry (const version)
virtual double operator[] (uint i) const
{ return (*x)(i); };
/// Access value of given entry (non-const version)
double& operator[] (uint i)
{ return (*x)(i); };
/// Assignment operator
const uBLASVector& operator= (const uBLASVector& x);
private:
// Smart pointer to uBLAS vector object
boost::shared_ptr<ublas_vector> x;
};
}
#endif
|