/usr/include/linbox/randiter/abstract.h is in liblinbox-dev 1.4.2-3.
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 | /* linbox/randiter/abstract.h
* Copyright (C) 1999-2001 William J Turner,
* 2002 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_randiter_abstract_H
#define __LINBOX_randiter_abstract_H
#include <iostream>
#include "linbox/integer.h"
namespace LinBox
{
// forward declarations
class FieldAbstract;
class ElementAbstract;
/** Random field element generator.
* This encapsulated class is a generator of random field elements for
* the encapsulating field.
* It is required to contain constructors from a field object and
* two integers. The first integer being a cardinality of a set to
* draw the random elements from, and the second being a seed for the
* random number generator.
* It is also required to contain a copy constructor, a destructor, and
* random() which acts on a reference to a field element.
* The random value is written to the argument
* and also returned as a reference.
* @see \subpage randomFEGW Randiter Field Element Generator wrapper
*/
class RandIterAbstract {
public:
typedef ElementAbstract Element;
/** Virtual constructor from field, sampling size, and seed.
* Required because constructors cannot be virtual.
* Passes construction on to derived classes.
* The random field element iterator works in the field F, is seeded
* by seed, and it returns any one element with probability no more
* than 1/min (size, F.cardinality (c)).
* A sampling size of zero means to sample from the entire field.
* A seed of zero means to use some arbitrary seed for the generator.
* Purely virtual.
* @param F LinBox field archetype object in which to do arithmetic
* @param size constant integer reference of sample size from which to
* sample (default = 0)
* @param seed constant integer reference from which to seed random number
* generator (default = 0)
*/
virtual RandIterAbstract *construct (const FieldAbstract &F,
const integer &size = 0,
const integer &seed = 0) const = 0;
/** Virtual copy constructor.
* Required because constructors cannot be virtual.
* Passes construction on to derived classes.
* Purely virtual.
* @return pointer to new RandIterAbstract object in dynamic memory.
*/
virtual RandIterAbstract *clone (void) const = 0;
/** Assignment operator.
* Purely virtual.
* @param x constant reference to RandIterAbstract object
* @return reference to self
*/
virtual RandIterAbstract &operator= (const RandIterAbstract &x) = 0;
/** Destructor.
*/
virtual ~RandIterAbstract (void) {}
/** Random field element creator.
* Purely virtual.
* @return reference to ElementAbstract object
*/
virtual Element &random (Element &a) = 0;
protected:
/** Default constructor
* Required by derived classes, but protected because this class should
* never be constructed by itself.
*/
RandIterAbstract (void) {}
}; // class RandIterAbstract
} // namespace LinBox
#endif // __LINBOX_randiter_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:
|