/usr/include/linbox/field/abstract.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 | /* linbox/field/abstract.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_abstract_H
#define __LINBOX_abstract_H
#include <iostream>
#include "linbox/element/abstract.h"
#include "linbox/randiter/abstract.h"
#include "linbox/integer.h"
#include "linbox/linbox-config.h"
#ifdef __LINBOX_XMLENABLED
#include "linbox/util/xml/linbox-reader.h"
#include "linbox/util/xml/linbox-writer.h"
#endif
namespace LinBox
{
/** \brief field base class.
\ingroup field
* Found in the file \sa{linbox/field/abstract.h}.
* Abstract base class used to implement the field archetype to minimize
* code bloat. All public member functions of this class are purely
* virtual and must be implemented by all derived classes.
*
* If a template is instantiated on the field archetype, we can change the
* field it is using by changing the derived class of this class. This allows
* us to change the field used in a template without having to reinstantiate
* it. This minimizes code bloat, but it also introduces indirection through
* the use of pointers and virtual functions which is inefficient.
*/
class FieldAbstract {
public:
/// element type.
typedef ElementAbstract Element;
/// Random iterator generator type.
typedef RandIterAbstract RandIter;
/** @name Object Management
* There are no public constructors for this class.
* It should only be used in tandem with \ref FieldArchetype.
*/
//@{
/** Destructor.
* Required because of virtual member functions.
* Virtual.
*/
virtual ~FieldAbstract (void) {}
/** Virtual copy constructor.
* Required because constructors cannot be virtual.
* Passes construction on to derived classes.
* Purely virtual.
* This function is not part of the common object interface.
* @return pointer to new object in dynamic memory.
*/
virtual FieldAbstract* clone () const = 0;
/** Assignment operator.
* Purely virtual.
* @return reference to self
* @param F constant reference to FieldAbstract object
*/
virtual FieldAbstract &operator= (const FieldAbstract &F) = 0;
/** Initialization of field element from an integer.
* Behaves like C++ allocator construct.
* This function assumes the output field element x has already been
* constructed, but that it is not already initialized.
* Purely virtual.
* @return reference to field element.
* @param x field element to contain output (reference returned).
* @param y integer.
*/
virtual Element &init (Element &x, const integer &y) const = 0;
/** Conversion of field element to an integer.
* This function assumes the output field element x has already been
* constructed, but that it is not already initialized.
* Purely virtual.
* @return reference to integer.
* @param x reference to interger to contain output (reference returned).
* @param y constant field element.
*/
virtual integer &convert (integer &x, const Element &y) const = 0;
/** Assignment of one field element to another.
* This function assumes both field elements have already been
* constructed and initialized.
* Purely virtual.
* @return reference to x
* @param x field element (reference returned).
* @param y field element.
*/
virtual Element &assign (Element &x, const Element &y) const = 0;
/** Cardinality.
* Return integer representing cardinality of the domain.
* Returns a non-negative integer for all domains with finite
* cardinality, and returns -1 to signify a domain of infinite
* cardinality.
* Purely virtual.
* @return integer representing cardinality of the domain
*/
virtual integer &cardinality (integer &c) const = 0;
/** Characteristic.
* Return integer representing characteristic of the domain.
* Returns a positive integer to all domains with finite characteristic,
* and returns 0 to signify a domain of infinite characteristic.
* Purely virtual.
* @return integer representing characteristic of the domain.
*/
virtual integer &characteristic (integer &c) const = 0;
//@} Object Management
/** @name Arithmetic Operations
* x <- y op z; x <- op y
* These operations require all elements, including x, to be initialized
* before the operation is called. Uninitialized field elements will
* give undefined results.
*/
//@{
/** Equality of two elements.
* This function assumes both field elements have already been
* constructed and initialized.
* Purely virtual.
* @return boolean true if equal, false if not.
* @param x field element
* @param y field element
*/
virtual bool areEqual (const Element &x, const Element &y) const = 0;
/** Addition.
* x = y + z
* This function assumes all the field elements have already been
* constructed and initialized.
* Purely virtual.
* @return reference to x.
* @param x field element (reference returned).
* @param y field element.
* @param z field element.
*/
virtual Element &add (Element &x,
const Element &y,
const Element &z) const = 0;
/** Subtraction.
* x = y - z
* This function assumes all the field elements have already been
* constructed and initialized.
* Purely virtual.
* @return reference to x.
* @param x field element (reference returned).
* @param y field element.
* @param z field element.
*/
virtual Element &sub (Element &x,
const Element &y,
const Element &z) const = 0;
/** Multiplication.
* x = y * z
* This function assumes all the field elements have already been
* constructed and initialized.
* Purely virtual.
* @return reference to x.
* @param x field element (reference returned).
* @param y field element.
* @param z field element.
*/
virtual Element &mul (Element &x,
const Element &y,
const Element &z) const = 0;
/** Division.
* x = y / z
* This function assumes all the field elements have already been
* constructed and initialized.
* Purely virtual.
* @return reference to x.
* @param x field element (reference returned).
* @param y field element.
* @param z field element.
*/
virtual Element &div (Element &x,
const Element &y, const Element &z) const = 0;
/** Additive Inverse (Negation).
* x = - y
* This function assumes both field elements have already been
* constructed and initialized.
* Purely virtual.
* @return reference to x.
* @param x field element (reference returned).
* @param y field element.
*/
virtual Element &neg (Element &x, const Element &y) const = 0;
/** Multiplicative Inverse.
* x = 1 / y
* This function assumes both field elements have already been
* constructed and initialized.
* Purely virtual.
* @return reference to x.
* @param x field element (reference returned).
* @param y field element.
*/
virtual Element &inv (Element &x, const Element &y) const = 0;
/** Natural AXPY.
* r = a * x + y
* This function assumes all field elements have already been
* constructed and initialized.
* Purely virtual.
* @return reference to r.
* @param r field element (reference returned).
* @param a field element.
* @param x field element.
* @param y field element.
*/
virtual Element &axpy (Element &r,
const Element &a,
const Element &x,
const Element &y) const = 0;
//@} Arithmetic Operations
/** @name Inplace Arithmetic Operations
* x <- x op y; x <- op x
*/
//@{
/** Zero equality.
* Test if field element is equal to zero.
* This function assumes the field element has already been
* constructed and initialized.
* Purely virtual.
* @return boolean true if equals zero, false if not.
* @param x field element.
*/
virtual bool isZero (const Element &x) const = 0;
/** One equality.
* Test if field element is equal to one.
* This function assumes the field element has already been
* constructed and initialized.
* Purely virtual.
* @return boolean true if equals one, false if not.
* @param x field element.
*/
virtual bool isOne (const Element &x) const = 0;
/** Inplace Addition.
* x += y
* This function assumes both field elements have already been
* constructed and initialized.
* Purely virtual.
* @return reference to x.
* @param x field element (reference returned).
* @param y field element.
*/
virtual Element &addin (Element &x, const Element &y) const = 0;
/** Inplace Subtraction.
* x -= y
* This function assumes both field elements have already been
* constructed and initialized.
* Purely virtual.
* @return reference to x.
* @param x field element (reference returned).
* @param y field element.
*/
virtual Element &subin (Element &x, const Element &y) const = 0;
/** Inplace Multiplication.
* x *= y
* This function assumes both field elements have already been
* constructed and initialized.
* Purely virtual.
* @return reference to x.
* @param x field element (reference returned).
* @param y field element.
*/
virtual Element &mulin (Element &x, const Element &y) const = 0;
/** Inplace Division.
* x /= y
* This function assumes both field elements have already been
* constructed and initialized.
* Purely virtual.
* @return reference to x.
* @param x field element (reference returned).
* @param y field element.
*/
virtual Element &divin (Element &x, const Element &y) const = 0;
/** Inplace Additive Inverse (Inplace Negation).
* x = - x
* This function assumes the field element has already been
* constructed and initialized.
* Purely virtual.
* @return reference to x.
* @param x field element (reference returned).
*/
virtual Element &negin (Element &x) const = 0;
/** Inplace Multiplicative Inverse.
* x = 1 / x
* This function assumes the field elementhas already been
* constructed and initialized.
* Purely virtual.
* @return reference to x.
* @param x field element (reference returned).
*/
virtual Element &invin (Element &x) const = 0;
/** Inplace AXPY.
* r += a * x
* This function assumes all field elements have already been
* constructed and initialized.
* Purely virtual
* @return reference to r.
* @param r field element (reference returned).
* @param a field element.
* @param x field element.
*/
virtual Element &axpyin (Element &r,
const Element &a,
const Element &x) const = 0;
//@} Inplace Arithmetic Operations
#ifndef __LINBOX_XMLENABLED
/** @name Input/Output Operations */
//@{
/** Print field.
* Purely virtual.
* @return output stream to which field is written.
* @param os output stream to which field is written.
*/
virtual std::ostream &write (std::ostream &os) const = 0;
/** Read field.
* Purely virtual.
* @return input stream from which field is read.
* @param is input stream from which field is read.
*/
virtual std::istream &read (std::istream &is) = 0;
/** Print field element.
* This function assumes the field element has already been
* constructed and initialized.
* Purely virtual.
* @return output stream to which field element is written.
* @param os output stream to which field element is written.
* @param x field element.
*/
virtual std::ostream &write (std::ostream &os, const Element &x) const = 0;
/** Read field element.
* This function assumes the field element has already been
* constructed and initialized.
* Purely virtual.
* @return input stream from which field element is read.
* @param is input stream from which field element is read.
* @param x field element.
*/
virtual std::istream &read (std::istream &is, Element &x) const = 0;
//@}
#else
virtual std::ostream &write(std::ostream &os) const = 0;
virtual bool toTag(Writer &W) const = 0;
virtual std::ostream &write(std::ostream &os, const Element &e) const = 0;
virtual bool toTag(Writer &W, const Element &e) const = 0;
virtual std::istream &read(std::istream &is, Element &e) const = 0;
virtual bool fromTag(Reader &R, Element &e) const = 0;
#endif
protected:
/** Default Constructor.
* Required by derived classes, but protected because this class should
* never be constructed by itself.
*/
FieldAbstract () {}
private:
/// FieldArchetype is friend.
friend class FieldArchetype;
}; // class FieldAbstract
} // namespace LinBox
#endif // __LINBOX_abstract_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:
|