Frobby  0.9.0
BigTermRecorder.h
Go to the documentation of this file.
1 /* Frobby: Software for monomial ideal computations.
2  Copyright (C) 2007 Bjarke Hammersholt Roune (www.broune.com)
3 
4  This program is free software; you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation; either version 2 of the License, or
7  (at your option) any later version.
8 
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with this program. If not, see http://www.gnu.org/licenses/.
16 */
17 #ifndef BIG_TERM_RECORDER_GUARD
18 #define BIG_TERM_RECORDER_GUARD
19 
20 #include "BigTermConsumer.h"
21 #include "ElementDeleter.h"
22 
23 #include "VarNames.h"
24 
25 #include <list>
26 
27 class BigIdeal;
28 class TermTranslator;
29 
32 public:
34 
35  virtual void consumeRing(const VarNames& names);
36  virtual void beginConsuming();
37  virtual void consume(const Term& term, const TermTranslator& translator);
38  virtual void consume(const vector<mpz_class>& term);
39  virtual void doneConsuming();
40 
41  virtual void consume(auto_ptr<BigIdeal> ideal);
42 
43  // Returns true if this object currently stores no ideals.
44  bool empty() const;
45 
46  // Returns the least recently consumed ideal from this and returns it.
47  // It is a precondition that empty() is false.
48  auto_ptr<BigIdeal> releaseIdeal();
49 
50  // Returns the most recently consumed ring.
51  const VarNames& getRing();
52 
53 private:
55  size_t _idealCount;
56  list<BigIdeal*> _ideals; // zero entries are treated as if not there.
58 };
59 
60 #endif
BigIdeal
Definition: BigIdeal.h:27
BigTermRecorder::BigTermRecorder
BigTermRecorder()
Definition: BigTermRecorder.cpp:24
BigTermRecorder::beginConsuming
virtual void beginConsuming()
Tell the consumer to begin consuming an ideal.
Definition: BigTermRecorder.cpp:38
ElementDeleter
Definition: ElementDeleter.h:50
BigTermConsumer.h
BigTermRecorder::releaseIdeal
auto_ptr< BigIdeal > releaseIdeal()
Definition: BigTermRecorder.cpp:74
BigTermRecorder::consumeRing
virtual void consumeRing(const VarNames &names)
Tell the consumer which ring is being used.
Definition: BigTermRecorder.cpp:29
BigTermRecorder::_names
VarNames _names
Definition: BigTermRecorder.h:54
BigTermRecorder
BigTermRecorder records all the terms it consumes into an ideal.
Definition: BigTermRecorder.h:31
TermTranslator
TermTranslator handles translation between terms whose exponents are infinite precision integers and ...
Definition: TermTranslator.h:41
BigTermRecorder::_idealCount
size_t _idealCount
Definition: BigTermRecorder.h:55
VarNames.h
Term
Term represents a product of variables which does not include a coefficient.
Definition: Term.h:49
BigTermConsumer
Definition: BigTermConsumer.h:29
BigTermRecorder::empty
bool empty() const
Definition: BigTermRecorder.cpp:70
BigTermRecorder::doneConsuming
virtual void doneConsuming()
Must be called once after each time beginConsuming has been called.
Definition: BigTermRecorder.cpp:67
BigTermRecorder::consume
virtual void consume(const Term &term, const TermTranslator &translator)
Definition: BigTermRecorder.cpp:44
BigTermRecorder::getRing
const VarNames & getRing()
Definition: BigTermRecorder.cpp:81
VarNames
Defines the variables of a polynomial ring and facilities IO involving them.
Definition: VarNames.h:40
BigTermRecorder::_idealsDeleter
ElementDeleter< list< BigIdeal * > > _idealsDeleter
Definition: BigTermRecorder.h:57
BigTermRecorder::_ideals
list< BigIdeal * > _ideals
Definition: BigTermRecorder.h:56
ElementDeleter.h