ravensat 0.3.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47afc062227efddad35ed4643e28c4eea8957ecb32c8aa34d3c69a9ff52d3a88
-  data.tar.gz: a39c4f15fb17321ded803e79b702c55150197b3a613a340ca4a728e0a6a27402
+  metadata.gz: 0fe48515db2ce222168fac2854fcab5b2057c84336195e129e6c532ab519082e
+  data.tar.gz: bc265a79298a55684d1bb1c83a196e0530b4670515c22d4388f65bdf7b872c67
 SHA512:
-  metadata.gz: f29375d0971be0c3a721e9932fec0b69ad9db5b6df089e9d07fad557a82fac176faf7b71eea0ca73b8ee76ba60b413bfc799fd2de798c0b0fc513e39c8c0388d
-  data.tar.gz: a596fa29bfb55341a016ddde64b2e7d788a4877d4504cd5921cee81e486ee28207fd14027c81c0e113c8485edd0cc9bd5921beac75728da85e3390c1eab4d23f
+  metadata.gz: 7d715763470fe222f0ba71c998e27a43f8e40c04ae50cadceae48b324a962eaa75ceef92f02154cc74f9e04edbae47de1f36eb6e3c655019c0f3fedd72aae448
+  data.tar.gz: d2178778880fa55127ef5bd0b2b5d76fa5431452d20f06b0672374a99f9a718a881c01c1c055b11579c86e063decc607416c0f3450213f460dac756e28cc201c

data/README.md

@@ -1,23 +1,26 @@
-# Ravensat
-
-[![Ruby](https://github.com/matsuda0528/ravensat/actions/workflows/main.yml/badge.svg)](https://github.com/matsuda0528/ravensat/actions/workflows/main.yml)
+[![GitHub Actions](https://github.com/matsuda0528/ravensat/actions/workflows/main.yml/badge.svg)](https://github.com/matsuda0528/ravensat/actions/workflows/main.yml)
 [![Gem Version](https://badge.fury.io/rb/ravensat.svg)](https://badge.fury.io/rb/ravensat)
 [![LICENSE](https://img.shields.io/github/license/matsuda0528/ravensat)](https://opensource.org/licenses/MIT)
 
-Ravensat is an interface to SAT solver in Ruby.
+<!-- [![GitHub Pages](https://img.shields.io/badge/GitHub%20Pages--brightgreen.svg?logo=github&style=social)](https://matsuda0528.github.io/ravensat/) -->
+
+# Ravensat
 
+Ravensat provides an intuitive interface for working with SAT solver.
+SAT solver is a useful tool for solving various problems, but it is not user-friendly.
+Ravensat wraps the SAT solver and makes it easier to use.
 In order to use Ravensat, you need to install SAT solver.
 If you do not install SAT solver, it will use the one bundled in the gem.
 
 About [SAT](https://en.wikipedia.org/wiki/Boolean_satisfiability_problem), [SAT solver](https://en.wikipedia.org/wiki/SAT_solver)
 
 ## Description
-To solve SAT, we usually use SAT solver.
+To solve SAT(Boolean Satisfiability Problem), we usually use SAT solver.
 Now, let's solve the following SAT with SAT solver.
-<p align="center">
-<img src="https://latex.codecogs.com/svg.image?\inline&space;\large&space;\bg{white}(1&space;\lor&space;\lnot&space;5&space;\lor&space;4)&space;\land&space;(\lnot&space;1&space;\lor&space;5&space;\lor&space;3&space;\lor&space;4)&space;\land&space;(\lnot&space;3&space;\lor&space;\lnot&space;4)" style="background-color:white;"/>
-</p>
 
+$$(p_{1} \lor \lnot p_{5} \lor p_{4}) \land (\lnot p_{1} \lor p_{5} \lor p_{3} \lor p_{4}) \land (\lnot p_{3} \lor \lnot p_{4})$$
+
+To solve the above SAT, give it to the SAT solver.
 Most SAT solvers are input in [DIMACS Format](https://www.cs.utexas.edu/users/moore/acl2/manuals/current/manual/index-seo.php/SATLINK____DIMACS).
 Converting the example SAT to DIMACS Format yields the following.
 
@@ -27,25 +30,37 @@ p cnf 5 3
 -1 5 3 4 0
 -3 -4 0
 ```
+
 DIMACS Format is widely distributed as an I/O format for SAT solver.
 However, when solving a large SAT, the following problems occur.
 - Need to create a file with thousands of lines.
 - Confusion arises because of the inability to name variables meaningfully.
 
-To solve these problems, Ravensat can be used.
+Therefore, we need an interface that can flexibly determine the names of variables and imperatively write loginal expressions.
+To achieve these requirements, we are developing Ravensat.
 Using Ravensat, propositional variables can be defined as local variables in Ruby.
+
 ```ruby
-fuji_is_the_highest_mountain_in_japan = Ravensat::VarNode.new
+John_is_a_male = Ravensat::VarNode.new
 ```
-In addition, you can write logical expressions intuitively.
+
+In addition, you can write logical expressions intuitively and imperatively.
+
 ```ruby
 x = Ravensat::VarNode.new
 y = Ravensat::VarNode.new
 
-# (x or y) and (not x or y)
 (x | y) & (~x | y)
 ```
 
+```ruby
+x = Ravensat::VarNode.new
+y = Ravensat::VarNode.new
+z = Ravensat::VarNode.new
+
+# (~x | ~y) & (~x | ~z) & (~y | ~z)
+Ravensat::Claw.pairwise_amo [x,y,z]
+```
 
 ## Installation
 
@@ -66,41 +81,39 @@ Or install it yourself as:
 ## Usage
 ### Basic Usage
 This is a basic usage example of the library.
+
 ```ruby
 require 'ravensat'
 
-# Define propositional variables
 a = Ravensat::VarNode.new
 b = Ravensat::VarNode.new
 
 a.result #=> nil
 b.result #=> nil
 
-# Generate logical expressions as CNF
 logic = (a | b) & (~a | b) & (a | ~b)
 
-# Launch SAT solver
 solver = Ravensat::Solver.new
 solver.solve logic #=> true(SAT)
 
-# Refer to the satisfiability
 a.result #=> true
 b.result #=> true
 ```
 
 If you have SAT solver installed, you can write:
+
 ```ruby
-# Launch SAT solver
 solver = Ravensat::Solver.new("<solver_name>")
 solver.solve logic
 ```
+
 The available solvers are assumed to be those that can be I/O in the DIMACS Format.
 At least, we have confirmed that it works properly with [MiniSat](https://github.com/niklasso/minisat).
 
 If you do not use an external SAT solver, create a SAT solver object without any constructor arguments.
 In that case, **Arcteryx**(the very simple SAT solver built into Ravensat) will launch.
 
-### Extension Usage
+### Extension Usage(prototype)
 In Ravensat::Extension, C-like variable definitions are available.
 
 *Note: In Ravensat::Extension, all undefined variables and methods are caught by method_missing method.*
@@ -122,8 +135,8 @@ module Ravensat
 end
 ```
 
-### Extension Usage(CSP; Constraint Satisfaction Problem)
 It is possible to define integer variables and to describe some integer constraints.
+
 ```ruby
 require 'ravensat'
 
@@ -147,10 +160,20 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/matsuda0528/ravensat.
 
-## License
+```
+ ____                                 _
+|  _ \ __ ___   _____ _ __  ___  __ _| |_
+| |_) / _` \ \ / / _ \ '_ \/ __|/ _` | __|
+|  _ < (_| |\ V /  __/ | | \__ \ (_| | |_
+|_| \_\__,_| \_/ \___|_| |_|___/\__,_|\__|
+
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).