/usr/include/linbox/randiter/envelope.h is in liblinbox-dev 1.3.2-1.1+b1.
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 | /* linbox/randiter/envelope.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_envelope_H
#define __LINBOX_randiter_envelope_H
#include <iostream>
#include "linbox/field/envelope.h"
#include "linbox/element/envelope.h"
#include "linbox/randiter/abstract.h"
namespace LinBox
{
/** Random field base element generator.
* This encapsulated class is a generator of random field base 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
* an operator() which acts on a reference to a field base element. In this
* operator(), the random element is placed into the input field base element
* and also returned as a reference.
*/
template <class Field>
class RandIterEnvelope : public RandIterAbstract {
public:
/// element type
//typedef ElementAbstract element;
typedef ElementEnvelope<Field> Element;
/** Constructor from field, sampling size, and seed.
* 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.
* @param F LinBox field envelope 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)
*/
RandIterEnvelope (const FieldEnvelope<Field> &F,
const integer &size = 0,
const integer &seed = 0) :
_randIter (F._field, size, seed)
{}
/** Constructor from random field element generator to be wrapped
* @param R random field element generator object to be wrapped
*/
RandIterEnvelope (const typename Field::RandIter &R) :
_randIter (R)
{}
/** Copy constructor.
* Constructs RandIterEnvelope object by copying the random field
* element generator.
* This is required to allow generator objects to be passed by value
* into functions.
* @param R RandIterEnvelope object.
*/
RandIterEnvelope (const RandIterEnvelope &R) :
RandIterAbstract(R), _randIter (R._randIter)
{}
/** Destructor.
* Required by abstract base class.
* This destructs the random field element generator object.
*/
~RandIterEnvelope () {}
/** Assignment operator.
* Assigns RandIterEnvelope object R to generator.
* Required by abstract base class.
* @param R RandIterEnvelope object.
*/
RandIterAbstract &operator= (const RandIterAbstract &R)
{
if (this != &R) // guard against self-assignment
_randIter = static_cast<const RandIterEnvelope&> (R)._randIter;
return *this;
}
/** 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.
* Required by abstract base class.
* @param F LinBox field abstract 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)
*/
RandIterAbstract *construct (const FieldAbstract &F,
const integer &size = 0,
const integer &seed = 0) const
{
return new RandIterEnvelope (static_cast<const FieldEnvelope<Field>&> (F)._field, size, seed);
}
/** Virtual copy constructor.
* Required because constructors cannot be virtual.
* Passes construction on to derived classes.
* Required by abstract base class.
* @return pointer to new RandIterAbstract object in dynamic memory.
*/
RandIterAbstract* clone (void) const
{ return new RandIterEnvelope (*this); }
/** Random field element creator.
* This returns a random field element from the information supplied
* at the creation of the generator.
* Required by abstract base class.
* @return reference to random field element
*/
ElementAbstract &random (ElementAbstract &a) const
//{ return _randIter.random (a); }
// GV Thu Apr 18 14:46:46 MEST 2002
// modify by P.G. 2004-07-16
{
_randIter.random(static_cast<ElementEnvelope<Field>&> (a)._elem );
return a;
}
private:
typename Field::RandIter _randIter;
}; // class RandIterEnvelope
} // namespace LinBox
#endif // __LINBOX_randiter_envelope_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:
|