/usr/include/linbox/ring/ring-interface.h is in liblinbox-dev 1.1.6~rc0-4.1.
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 | /* -*- mode: C++; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* linbox/ring/ring-interface.h
* Written by
* Jean-Guillaume Dumas <Jean-Guillaume.Dumas@imag.fr>
* Clément Pernet <Clement.Pernet@imag.fr>
*
* For licensing information see COPYING
*/
#ifndef __RING_INTERFACE_H
#define __RING_INTERFACE_H
namespace LinBox
{
// LinBox Ring Interface
/*
* The LinBox {@link Rings ring} common object {@link Interfaces interface}.
* The ring interface includes the following public members:
*
* Types: {\tt Element} and {\tt RandIter}.
*
* Object management member functions:
* null constructor, copy constructor, destructor, assignment operator,
* {\tt convert(), init(), assign(), characteristic(), cardinality()}.
*
* Predicates on ring elements:
* {\tt areEqual(), isZero(), isOne()}.
*
* Basic arithmetic functions:
* {\tt axpy(), add(), neg(), sub(), mul(), inv(), div()}.
*
* Inplace arithmetic functions:
* {\tt axpyin(), addin(), negin(), subin(), mulin(), invin(), divin()}.
*
* I/O functions:
* {\tt read()} and {\tt 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}. 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 // __RING_INTERFACE_H
|