ricosat 1.0.0

data/ext/ricosat/ricosat.c

@@ -0,0 +1,194 @@
+#include <ruby.h>
+#include <ruby/io.h>
+#include <picosat.h>
+
+VALUE cRicoSat;
+
+static const rb_data_type_t RicoSatType = {
+    "RicoStat",
+    { 0, (void (*)(void *))picosat_reset, 0 },
+    0, 0, RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+static VALUE allocate(VALUE klass) {
+  return TypedData_Wrap_Struct(klass, &RicoSatType, picosat_init());
+}
+
+static VALUE measure_all_calls(VALUE self) {
+    PicoSAT * sat;
+
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    picosat_measure_all_calls(sat);
+    return self;
+}
+
+static VALUE set_verbosity(VALUE self, VALUE verbosity) {
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    picosat_set_verbosity(sat, NUM2INT(verbosity));
+    return self;
+}
+
+static VALUE set_more_important_lit(VALUE self, VALUE lit) {
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    picosat_set_more_important_lit(sat, NUM2INT(lit));
+    return self;
+}
+
+static VALUE set_less_important_lit(VALUE self, VALUE lit) {
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    picosat_set_less_important_lit(sat, NUM2INT(lit));
+    return self;
+}
+
+static VALUE inc_max_var(VALUE self) {
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    return INT2NUM(picosat_inc_max_var(sat));
+}
+
+static VALUE add(VALUE self, VALUE lit) {
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    return INT2NUM(picosat_add(sat, NUM2INT(lit)));
+}
+
+static VALUE solve(VALUE self, VALUE limit) {
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    return INT2NUM(picosat_sat(sat, NUM2INT(limit)));
+}
+
+static VALUE deref(VALUE self, VALUE lit) {
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    switch(picosat_deref(sat, NUM2INT(lit))) {
+	case 1:
+	    return Qtrue;
+	case -1:
+	    return Qfalse;
+	case 0:
+	    return Qnil;
+    }
+    return Qnil;
+}
+
+static VALUE failed_assumptions(VALUE self) {
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+
+    VALUE failed_list = rb_ary_new();
+    const int * failed = picosat_failed_assumptions(sat);
+    while(*failed) {
+	rb_ary_push(failed_list, INT2NUM(*failed));
+	failed++;
+    }
+    return failed_list;
+}
+
+static VALUE failed_assumption(VALUE self, VALUE lit) {
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+
+    if (picosat_failed_assumption(sat, NUM2INT(lit))) {
+	return Qtrue;
+    } else {
+	return Qfalse;
+    }
+}
+
+static VALUE assume(VALUE self, VALUE lit) {
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    picosat_assume(sat, NUM2INT(lit));
+    return self;
+}
+
+static VALUE variables(VALUE self) {
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    return INT2NUM(picosat_variables(sat));
+}
+
+static VALUE enable_trace_generation(VALUE self)
+{
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    return INT2NUM(picosat_enable_trace_generation(sat));
+}
+
+static VALUE write_extended_trace(VALUE self, VALUE io)
+{
+    PicoSAT * sat;
+    rb_io_t * out;
+
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    GetOpenFile(io, out);
+    picosat_write_extended_trace(sat, fdopen(out->fd, "w"));
+    return self;
+}
+
+static VALUE corelit(VALUE self, VALUE lit)
+{
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    return INT2NUM(picosat_corelit(sat, NUM2INT(lit)));
+}
+
+static VALUE coreclause(VALUE self, VALUE i)
+{
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    return INT2NUM(picosat_coreclause(sat, NUM2INT(i)));
+}
+
+static VALUE added_original_clauses(VALUE self)
+{
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    return INT2NUM(picosat_added_original_clauses(sat));
+}
+
+static VALUE set_global_default_phase(VALUE self, VALUE val)
+{
+    PicoSAT * sat;
+    TypedData_Get_Struct(self, PicoSAT, &RicoSatType, sat);
+    picosat_set_global_default_phase(sat, NUM2INT(val));
+    return self;
+}
+
+void error_cb(const char *m) {
+    rb_raise(rb_eRuntimeError, "%s", m);
+}
+
+void Init_ricosat() {
+    cRicoSat = rb_define_class("RicoSAT", rb_cObject);
+    rb_define_alloc_func(cRicoSat, allocate);
+    picosat_set_error_handler(error_cb);
+
+    rb_define_const(cRicoSat, "UNKNOWN", INT2NUM(PICOSAT_UNKNOWN));
+    rb_define_const(cRicoSat, "SATISFIABLE", INT2NUM(PICOSAT_SATISFIABLE));
+    rb_define_const(cRicoSat, "UNSATISFIABLE", INT2NUM(PICOSAT_UNSATISFIABLE));
+    rb_define_method(cRicoSat, "measure_all_calls", measure_all_calls, 0);
+    rb_define_method(cRicoSat, "verbosity=", set_verbosity, 1);
+    rb_define_method(cRicoSat, "more_important_lit", set_more_important_lit, 1);
+    rb_define_method(cRicoSat, "less_important_lit", set_less_important_lit, 1);
+    rb_define_method(cRicoSat, "inc_max_var", inc_max_var, 0);
+    rb_define_method(cRicoSat, "add", add, 1);
+    rb_define_method(cRicoSat, "solve", solve, 1);
+    rb_define_method(cRicoSat, "deref", deref, 1);
+    rb_define_method(cRicoSat, "failed_assumptions", failed_assumptions, 0);
+    rb_define_method(cRicoSat, "assume", assume, 1);
+    rb_define_method(cRicoSat, "variables", variables, 0);
+    rb_define_method(cRicoSat, "failed_assumption", failed_assumption, 1);
+    rb_define_method(cRicoSat, "enable_trace_generation", enable_trace_generation, 0);
+    rb_define_method(cRicoSat, "write_extended_trace", write_extended_trace, 1);
+    rb_define_method(cRicoSat, "corelit", corelit, 1);
+    rb_define_method(cRicoSat, "coreclause", coreclause, 1);
+    rb_define_method(cRicoSat, "added_original_clauses", added_original_clauses, 0);
+    rb_define_method(cRicoSat, "global_default_phase=", set_global_default_phase, 1);
+}
+
+/* vim: set sws=4 noet: */

data/lib/ricosat.rb

@@ -0,0 +1,5 @@
+require 'ricosat.so'
+
+class RicoSAT
+  VERSION = '1.0.0'
+end

data/test/test_ricosat.rb

@@ -0,0 +1,140 @@
+require 'minitest/autorun'
+require 'tempfile'
+require 'ricosat'
+
+class TestRicosat < MiniTest::Test
+  def test_sanity
+    assert RicoSAT.new
+  end
+
+  def test_measure_all_calls
+    assert RicoSAT.new.measure_all_calls
+  end
+
+  def test_set_verbosity
+    sat = RicoSAT.new
+    sat.verbosity = 2
+  end
+
+  def test_int_max_var
+    sat = RicoSAT.new
+    assert_equal 1, sat.inc_max_var
+    assert_equal 2, sat.inc_max_var
+    assert_equal 3, sat.inc_max_var
+  end
+
+  def test_enable_trace
+    sat = RicoSAT.new
+    assert sat.enable_trace_generation
+    sat.add(1); sat.add(0)
+    assert_raises do
+      sat.write_extended_trace $stdout
+    end
+    sat.add(-1); sat.add(0)
+    sat.solve(-1)
+    f = Tempfile.new('trace')
+    assert sat.write_extended_trace File.open(f.path, 'w')
+    f.unlink
+  end
+
+  def test_added_original_clauses
+    sat = RicoSAT.new
+    sat.add(1); sat.add(0)
+    assert_equal 1, sat.added_original_clauses
+    sat.add(1); sat.add(0)
+    assert_equal 2, sat.added_original_clauses
+  end
+
+  def test_add_returns_current_clause
+    sat = RicoSAT.new
+    assert_equal 0, sat.add(1)
+    assert_equal 0, sat.add(0)
+    assert_equal 1, sat.add(1)
+    assert_equal 1, sat.add(0)
+  end
+
+  # A -> [B, C]
+  # B -> [D, =1]
+  # C -> [D, =2]
+  def test_diamond
+    sat = RicoSAT.new
+    sat.enable_trace_generation
+    sat.add(1); sat.add(0)               # A -> [B & C]
+    sat.add(2); sat.add(-1); sat.add(0)  # B | !A
+    sat.add(3); sat.add(-1); sat.add(0)  # C | !A
+    sat.add(4); sat.add(-2); sat.add(0)  # D | !B
+    sat.add(4); sat.add(-3); sat.add(0)  # D | !C
+    sat.add(-4); sat.add(5); sat.add(0)  # Dv1 | !D
+    sat.add(-4); sat.add(-6); sat.add(0)  # Dv1 | !D
+    sat.add(-4); sat.add(6); sat.add(0)  # Dv2 | !D
+    sat.add(-4); sat.add(-5); sat.add(0)  # Dv2 | !D
+    assert_equal RicoSAT::UNSATISFIABLE, sat.solve(-1)
+  end
+
+  def test_extended_trace
+    sat = RicoSAT.new
+    sat.enable_trace_generation
+    sat.add(1); sat.add(0)
+    sat.add(2); sat.add(0)
+    sat.add(-1); sat.add(2); sat.add(0)
+    sat.add(-1); sat.add(2); sat.add(0)
+    sat.add(-2); sat.add(-1); sat.add(0)
+    assert_equal RicoSAT::UNSATISFIABLE, sat.solve(-1)
+    # find core clauses that couldn't be solved
+    x = sat.added_original_clauses.times.find_all do |i|
+      sat.coreclause(i) == 1
+    end
+    assert_equal [0, 1, 4], x
+    # sat.write_extended_trace $stdout
+  end
+
+  def test_deref_fail
+    sat = RicoSAT.new
+    sat.assume 1
+    sat.assume 2
+    sat.add(-1); sat.add(2); sat.add(0)
+    sat.add(-2); sat.add(0)
+    assert_equal RicoSAT::UNSATISFIABLE, sat.solve(-1)
+    assert sat.failed_assumption 1
+    assert_equal [1], sat.failed_assumptions
+
+    assert_raises do
+      sat.deref 1
+    end
+  end
+
+  def test_deref_success
+    sat = RicoSAT.new
+    sat.add(1);  sat.add(0)
+    sat.add(-1); sat.add(2); sat.add(0)
+    assert_equal RicoSAT::SATISFIABLE, sat.solve(-1)
+
+    assert_equal [true, true], [1, 2].map { |i| sat.deref i }
+  end
+
+  def test_solve
+    sat = RicoSAT.new
+    sat.add(1);  sat.add(0)
+    sat.add(-1); sat.add(2); sat.add(0)
+    assert_equal RicoSAT::SATISFIABLE, sat.solve(-1)
+  end
+
+  def test_add
+    sat = RicoSAT.new
+    #sat.add(-2); sat.add(0)
+    sat.add(-1); sat.add(-3); sat.add(0)
+    sat.add(1); sat.add(2); sat.add(0)
+    sat.add(2); sat.add(3); sat.add(0)
+    case sat.solve(-1)
+    when RicoSAT::SATISFIABLE
+      assert sat.deref(2)
+      refute sat.deref(-2)
+      assert sat.deref(-3)
+      assert sat.deref(-1)
+    when RicoSAT::UNSATISFIABLE
+      flunk "should be satisfiable"
+    when RicoSAT::UNKNOWN
+      flunk "should be satisfiable"
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: ricosat
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Patterson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+description: |-
+  RicoSAT is a wrapper around [PicoSAT](http://fmv.jku.at/picosat/).  It lets
+  you use the PicoSAT solver from Ruby!
+email:
+- aaron@tenderlovemaking.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- ext/ricosat/extconf.rb
+- ext/ricosat/picosat.c
+- ext/ricosat/picosat.h
+- ext/ricosat/ricosat.c
+- lib/ricosat.bundle
+- lib/ricosat.rb
+- test/test_ricosat.rb
+homepage: https://github.com/tenderlove/ricosat
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: RicoSAT is a wrapper around [PicoSAT](http://fmv.jku.at/picosat/)
+test_files: []