ravensat 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47afc062227efddad35ed4643e28c4eea8957ecb32c8aa34d3c69a9ff52d3a88
-  data.tar.gz: a39c4f15fb17321ded803e79b702c55150197b3a613a340ca4a728e0a6a27402
+  metadata.gz: f369c1036cde3ea2ff754109809d5b4ce62f826a2ab409e9ec19fdd07ff341dc
+  data.tar.gz: 76df72fb98e5140fcd1b2b394643f23de5218ea47f4ec03f450dc0a05074f801
 SHA512:
-  metadata.gz: f29375d0971be0c3a721e9932fec0b69ad9db5b6df089e9d07fad557a82fac176faf7b71eea0ca73b8ee76ba60b413bfc799fd2de798c0b0fc513e39c8c0388d
-  data.tar.gz: a596fa29bfb55341a016ddde64b2e7d788a4877d4504cd5921cee81e486ee28207fd14027c81c0e113c8485edd0cc9bd5921beac75728da85e3390c1eab4d23f
+  metadata.gz: b59a47f2b7a899e49d506f839c892178523ea3920e611278e0f31399dc1c0e5c868bb8f8a74adab5a848f26f2d2efb8779f6391a20ec566ec177a1fdacfb4565
+  data.tar.gz: 9ed85ceb8abc589197c9241679bb5c5486ce525e427d91f84568dcc4b4ab7a58b0d110688cba999d78dacc9fd0e067d6e4f3908ef87d2d3851ed7c30331d22ca

data/README.md

@@ -1,9 +1,11 @@
 # 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)
 
+[![GitHub Pages](https://img.shields.io/badge/GitHub%20Pages--brightgreen.svg?logo=github&style=social)](https://matsuda0528.github.io/ravensat/)
+
 Ravensat is an interface to SAT solver in Ruby.
 
 In order to use Ravensat, you need to install SAT solver.
@@ -14,9 +16,8 @@ About [SAT](https://en.wikipedia.org/wiki/Boolean_satisfiability_problem), [SAT
 ## Description
 To solve SAT, 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})$$
 
 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,6 +28,7 @@ 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.
@@ -34,16 +36,18 @@ However, when solving a large SAT, the following problems occur.
 
 To solve these problems, Ravensat can be used.
 Using Ravensat, propositional variables can be defined as local variables in Ruby.
+
 ```ruby
 fuji_is_the_highest_mountain_in_japan = Ravensat::VarNode.new
 ```
+
 In addition, you can write logical expressions intuitively.
+
 ```ruby
 x = Ravensat::VarNode.new
 y = Ravensat::VarNode.new
 
-# (x or y) and (not x or y)
-(x | y) & (~x | y)
+(x | y) & (~x | y) # (x or y) and (not x or y)
 ```
 
 
@@ -66,34 +70,32 @@ 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).
 
@@ -124,6 +126,7 @@ 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 +150,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).