engine.h File Reference

Legacy umbrella header that re-exports the per-area interface headers and carries the still-unmigrated entry points. More...

#include "engine-includes.hpp"
#include "interface/aring.h"
#include "interface/computation.h"
#include "interface/cra.h"
#include "interface/factory.h"
#include "interface/flint.h"
#include "interface/freemodule.h"
#include "interface/groebner.h"
#include "interface/matrix.h"
#include "interface/monoid.h"
#include "interface/monomial-ideal.h"
#include "interface/monomial-ordering.h"
#include "interface/mutable-matrix.h"
#include "interface/random.h"
#include "interface/ring.h"
#include "interface/ringelement.h"
#include "interface/ringmap.h"
#include "interface/NAG.h"

Go to the source code of this file.

Functions
void	IM2_initialize (void)
M2_string	IM2_last_error_message (void)
M2_string	engineMemory ()
M2_string	rawMutableComplexToString (const MutableComplex *M)
unsigned int	rawMutableComplexHash (const MutableComplex *M)
MutableComplex *	rawMutableComplex (const engine_RawMutableMatrixArray M)
M2_arrayint	rawPruneBetti (MutableComplex *C, int n, int f)
MutableComplex *	rawPruneComplex (MutableComplex *C, int n, int f)
engine_RawMutableMatrixArray	rawPruningMorphism (MutableComplex *C, int n, int f)
Matrix *	rawLiftLocalMatrix (const Ring *R, const Matrix *m)
M2_bool	rawIsLocalUnit (const RingElement *f)
Computation *	IM2_Computation_set_stop (Computation *G, M2_bool always_stop, M2_arrayint degree_limit, int basis_element_limit, int syzygy_limit, int pair_limit, int codim_limit, int subring_limit, M2_bool just_min_gens, M2_arrayint length_limit)
Computation *	rawStartComputation (Computation *G)
enum ComputationStatusCode	rawStatus1 (Computation *C)
int	rawStatus2 (Computation *C)
M2_string	IM2_GB_to_string (Computation *C)
unsigned int	rawComputationHash (const Computation *C)
void	rawShowComputation (const Computation *C)
Computation *	IM2_res_make (const Matrix *m, M2_bool resolve_cokernel, int max_level, M2_bool use_max_slanted_degree, int max_slanted_degree, int algorithm, int strategy, M2_bool parallelizeByDegree)
const Matrix *	rawResolutionGetMatrix (Computation *G, int level)
MutableMatrix *	rawResolutionGetMatrix2 (Computation *G, int level, int degree)
MutableMatrix *	rawResolutionGetMutableMatrixB (Computation *C, const Ring *R, int level)
MutableMatrix *	rawResolutionGetMutableMatrix2B (Computation *C, const Ring *KK, int level, int degree)
const FreeModule *	rawResolutionGetFree (Computation *G, int level)
M2_arrayint	rawResolutionBetti (Computation *G, int type)
int	IM2_Resolution_status (Computation *G, int *complete_up_through_this_degree, int *complete_up_through_this_level)
enum ComputationStatusCode	IM2_Resolution_status_level (Computation *G, int level, M2_bool minimize, int *complete_up_through_this_degree)
Matrix *	rawSubduction (int numparts, const Matrix *M, const RingMap *F, Computation *C)
M2_bool	rawIdealOfPoints (const Ring *R, const MutableMatrix *Pts, Matrix **result_GB, Matrix **result_std_monoms)
const Matrix *	rawGbBoolean (const Matrix *m)
const Matrix *	rawBIBasis (const Matrix *m, int toGroebner)

Detailed Description

Legacy umbrella header that re-exports the per-area interface headers and carries the still-unmigrated entry points.

Note

AI-generated documentation. Verify against the source before relying on it.

engine.h historically declared every public entry point in one place. Today it forward-declares the engine's user-facing handle types (FreeModule, Matrix, MutableMatrix, RingMap, Computation, MutableComplex) under the same dual C/C++ pattern that each interface/*.h uses, then #includes the per-area interface headers so that a single #include "engine.h" still resolves to the public surface. It also keeps a tail of entry points that have not yet migrated out: the engine-startup pair IM2_initialize and IM2_last_error_message, the engineMemory() diagnostic, the entire MutableComplex family (rawMutableComplex, rawMutableComplexToString, rawMutableComplexHash, rawPruneBetti, rawPruneComplex, ...), and the resolution- specific entries (rawResolutionBetti, rawResolutionGetMutableMatrixB / rawResolutionGetMutableMatrix2B, IM2_Resolution_status / _status_level, ...) that the interface/groebner.h headerization left behind. New engine code is encouraged to reach for only the narrower interface/<area>.h headers — doing so reduces compile-time include bloat and makes dependencies explicit — but this header remains for backward compatibility with callers outside the engine and as the documented front-door entry point.

The exact set of locally-declared entries drifts over time as files migrate out of the legacy bucket; the file itself is the authoritative inventory. engine-includes.hpp carries the engine-wide baseline (config.h, M2_* typedefs) that this header layers on top of.

See also

engine-includes.hpp

Definition in file engine.h.