kiwi-java/README.md

40 lines
1.5 KiB
Markdown
Raw Normal View History

2015-01-30 16:51:32 +00:00
# kiwi-java
2016-01-31 19:42:13 +00:00
A Java port of the [Kiwi C++](https://github.com/nucleic/kiwi) implementation of the Cassowary constraint solving algorithm
## Background
This project was created by porting [Kiwi](https://github.com/nucleic/kiwi) line for line to Java. The objective is to create a faster Java implementation of the Cassowary constraint solving algorithm.
2016-01-30 12:03:27 +00:00
## History
The initial porting work was done in a weekend in at the end of January 2015 by Alex Birkett without a deep understanding of the Cassowary algorithm.
At that time, the tests ported from the [java cassowary project](https://github.com/pybee/cassowary-java), did not pass.
The project was forgotten about until early 2016 when [yonsunCN](https://github.com/yongsunCN) found it and fixed it.
As of January 2016, the testes ported from [java cassowary project](https://github.com/pybee/cassowary-java) now pass.
2016-01-30 12:08:37 +00:00
## Contributors
* [Alex Birkett](https://github.com/alexbirkett) Initial port from Kiwi C++
* [yonsunCN](https://github.com/yongsunCN) Fixed initial port
* [Sam Twidale](https://github.com/Tw1ddle) Multiple bug fixes
2016-01-30 12:08:37 +00:00
## Example usage
Solver solver = new Solver();
Variable x = new Variable("x");
Variable y = new Variable("y");
// x = 20
solver.addConstraint(Symbolics.equals(x, 20));
// x + 2 == y + 10
solver.addConstraint(Symbolics.equals(Symbolics.add(x,2), Symbolics.add(y, 10)));
solver.updateVariables();
System.out.println("x " + x.getValue() + " y " + y.getValue());
// x == 20
// y == 12