3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-10-08 00:41:56 +00:00
z3/src/sat/sat_clause_use_list.h
LeeYoungJoon 0a93ff515d
Centralize and document TRACE tags using X-macros (#7657)
* Introduce X-macro-based trace tag definition
- Created trace_tags.def to centralize TRACE tag definitions
- Each tag includes a symbolic name and description
- Set up enum class TraceTag for type-safe usage in TRACE macros

* Add script to generate Markdown documentation from trace_tags.def
- Python script parses trace_tags.def and outputs trace_tags.md

* Refactor TRACE_NEW to prepend TraceTag and pass enum to is_trace_enabled

* trace: improve trace tag handling system with hierarchical tagging

- Introduce hierarchical tag-class structure: enabling a tag class activates all child tags
- Unify TRACE, STRACE, SCTRACE, and CTRACE under enum TraceTag
- Implement initial version of trace_tag.def using X(tag, tag_class, description)
  (class names and descriptions to be refined in a future update)

* trace: replace all string-based TRACE tags with enum TraceTag
- Migrated all TRACE, STRACE, SCTRACE, and CTRACE macros to use enum TraceTag values instead of raw string literals

* trace : add cstring header

* trace : Add Markdown documentation generation from trace_tags.def via mk_api_doc.py

* trace : rename macro parameter 'class' to 'tag_class' and remove Unicode comment in trace_tags.h.

* trace : Add TODO comment for future implementation of tag_class activation

* trace : Disable code related to tag_class until implementation is ready (#7663).
2025-05-28 14:31:25 +01:00

138 lines
3.6 KiB
C++

/*++
Copyright (c) 2011 Microsoft Corporation
Module Name:
sat_clause_use_list.h
Abstract:
Clause use list
Author:
Leonardo de Moura (leonardo) 2011-05-31.
Revision History:
--*/
#pragma once
#include "sat/sat_types.h"
#include "util/trace.h"
namespace sat {
/**
\brief Clause use list with delayed deletion.
*/
class clause_use_list {
clause_vector m_clauses;
unsigned m_size;
unsigned m_num_redundant;
public:
clause_use_list() {
STRACE(clause_use_list_bug, tout << "[cul_created] " << this << "\n";);
m_size = 0;
m_num_redundant = 0;
}
unsigned size() const {
return m_size;
}
unsigned num_redundant() const {
return m_num_redundant;
}
unsigned num_irredundant() const {
return m_size - m_num_redundant;
}
bool empty() const { return size() == 0; }
void insert(clause & c) {
STRACE(clause_use_list_bug, tout << "[cul_insert] " << this << " " << &c << "\n";);
SASSERT(!m_clauses.contains(&c));
SASSERT(!c.was_removed());
m_clauses.push_back(&c);
m_size++;
if (c.is_learned()) ++m_num_redundant;
}
void erase_not_removed(clause & c) {
STRACE(clause_use_list_bug, tout << "[cul_erase_not_removed] " << this << " " << &c << "\n";);
SASSERT(m_clauses.contains(&c));
SASSERT(!c.was_removed());
m_clauses.erase(&c);
m_size--;
if (c.is_learned()) --m_num_redundant;
}
void erase(clause & c) {
STRACE(clause_use_list_bug, tout << "[cul_erase] " << this << " " << &c << "\n";);
SASSERT(m_clauses.contains(&c));
// SASSERT(c.was_removed());
m_size--;
if (c.is_learned()) --m_num_redundant;
}
void block(clause const& c) {
SASSERT(c.is_learned());
++m_num_redundant;
SASSERT(check_invariant());
}
void unblock(clause const& c) {
SASSERT(!c.is_learned());
--m_num_redundant;
SASSERT(check_invariant());
}
void reset() {
m_clauses.finalize();
m_size = 0;
m_num_redundant = 0;
}
bool check_invariant() const;
// iterate & compress
class iterator {
clause_vector & m_clauses;
unsigned m_size;
unsigned m_i;
unsigned m_j;
void consume();
public:
iterator(clause_vector & v):m_clauses(v), m_size(v.size()), m_i(0) {
m_j = 0;
consume();
}
~iterator();
bool at_end() const { return m_i == m_size; }
clause & curr() const { SASSERT(!at_end()); return *(m_clauses[m_i]); }
void next() {
SASSERT(!at_end());
SASSERT(!m_clauses[m_i]->was_removed());
m_i++;
m_j++;
consume();
}
};
iterator mk_iterator() const { return iterator(const_cast<clause_use_list*>(this)->m_clauses); }
std::ostream& display(std::ostream& out) const {
iterator it = mk_iterator();
while (!it.at_end()) {
out << it.curr() << "\n";
it.next();
}
return out;
}
};
};