/usr/include/linbox/ring/ring-interface.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 | /* linbox/ring/ring-interface.h
* Copyright(C) LinBox
* Written by
* Jean-Guillaume Dumas <Jean-Guillaume.Dumas@imag.fr>
* Clément Pernet <Clement.Pernet@imag.fr>
* ========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_ring_interface_H
#define __LINBOX_ring_interface_H
namespace LinBox
{
// LinBox Ring Interface
/*
* The LinBox @link Rings ring@endlink common object @link Interfaces interface@endlink.
* The ring interface includes the following public members:
*
* Types: \c Element and \c RandIter.
*
* Object management member functions:
* null constructor, copy constructor, destructor, assignment operator,
* \c convert(), \c init(), \c assign(), \c characteristic(),\c cardinality().
*
* Predicates on ring elements:
* \c areEqual(), \c isZero(), \c isOne().
*
* Basic arithmetic functions:
* \c axpy(), \c add(), \c neg(), \c sub(), \c mul(), \c inv(), \c div().
*
* Inplace arithmetic functions:
* \c axpyin(), \c addin(), \c negin(), \c subin(), \c mulin(), \c invin(), \c divin().
*
* I/O functions:
* \c read() and \c write() for I/O of the ring itself and for I/O of its elements.
*
* The ring archetype class is is the reference instantiation of this
* interface and contains the generic specifications of the member functions.
* Documentation in other ring classes is more limited. It serves primarily to explain special properties
* specific to the class of the interface member functions and to explain any constructors
* or other functionality unique to the class.
*
* @see Interfaces
*/
/**
* @brief This ring base class exists solely to aid documentation organization.
* For the general ring member function documentation consult the
* @link RingArchetype RingArchetype@endlink. For specific properties
* of individual representations consult the specific ring classes.
*/
class RingInterface {
/*
public:
// this just demo's that some declarations could be here.
typedef ElementArchetype Element;
virtual Element& mul(Element& c, const Element& a, const Element& b) const = 0;
*/
};// empty class so doc++ makes a nice hierarchy.
} // namespace LinBox
#endif // __LINBOX_ring_interface_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:
|