/usr/include/mathic/DivFinder.h is in libmathic-dev 1.0~git20160320-4.
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 | #ifndef MATHIC_DIV_FINDER_GUARD
#define MATHIC_DIV_FINDER_GUARD
/** An object that supports queries for divisors of a monomial.
This is an object for documentation purposes. Use the concrete
implementations of this interface to get an actual DivFinder-like
object.
DivFinder stores configurable Entry objects that represent a monomial
together with any required additional information.
The class is parameterized on a Configuration. The Configuration class
must have the following members.
* A type Monomial
Represents a monomial.
* A type Entry
These are the things added to the finder. Entry represents a monomial
along with any additional required information that client code needs
to associate with monomials in the finder.
* A type Exponent
These are exponents of the monomials. Exponent must have a copy constructor,
an operator= and an operator< for comparision with other exponents.
* A function Exponent getExponent(Monomial m, size_t var) const
Returns the exponent of the variable var in m. m can be a const reference.
* A function bool divides(Entry a, Monomial b) const
* A function bool divides(Monomial a, Entry b) const
* A function bool divides(Entry a, Entry b) const
Returns whether a divides b. a and b can be const references. If Entry
and Monomial are the same type then only one function is needed.
* A function size_t getVarCount() const
Returns the number of variables. Variables are indexed from 0 to
getVarCount() - 1. Must be a positive number.
* static const bool UseDivMask
Set to true to use div masks to speed up queries. This must be a
static const data member.
* size_t getUseAutomaticRebuild() const
* double getRebuildRatio() const
* size_t getRebuildMin() const
If getUseAutomaticRebuild() returns true, the tree will call rebuild
after a total of max(size() * getRebuildRatio(), getRebuildMin())
entry insertions and removals have occurred. A rebuild ratio of 0.5
and a minimum of 500 has worked well for random vectors.
* A method bool isLessThan(Entry a, Monomial b) const
* A method bool isLessThan(Monomial a, Entry b) const
* A method bool isLessThan(Entry a, Entry b) const
isLessThan must define a total order < on entries/monomials. a and b can
be const references. If Entry and Monomial are the same type then only
one function is needed.
It is possible to obtain non-const Entries from a DivFinder. It is allowed
to change these, but the monomial they represent must not change. When the
DivFinder calls some method X on the Configuration, the Configuration must
not in return cause a method to be called on the DivFinder until the method
X has returned. This is because the DivFinder may not be in a valid state
at the time it is calling X.
@todo: put these docs somewhere else.
*/
namespace {
template<class Configuration>
class DivFinder; // no implementation
}
#endif
|