diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5e59fce --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2015 Joshua Moerman + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 6b0e432..ac73941 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,24 @@ Yannakakis An algorithm to construct an adaptive distinguishing sequence for a mealy machine. If it does not exist, a partial sequence will be generated, which is still useful for generating a seperating set (in the sense of Lee and -Yannakakis). The partial leaves will be augmented via the classical -seperating sequences. +Yannakakis). The partial leaves will be augmented via ordinary seperating +sequences. In effect, the resulting test method is an instantiation of the HSI- +method, which tends towards the DS-method. + +Most of the algorithms are found in the directory `lib/` and their usage is best +illustrated in `src/main.cpp` or `src/methods.cpp`. + +Currently states and inputs are encoded internally as integer values (because +this enables fast indexing). Only for I/O, maps are used to translate between +integers and strings. To reduce the memory footprint `uint16_t`s are used, as +the range is big enough for our use cases (`uint8_t` is clearly too small for +the number of states, but could be used for alphabets). ## Building +The only dependency is boost. In order to build the project, one can use cmake. + ``` mkdir build cd build @@ -18,8 +30,10 @@ make ``` Then every .cpp file in the src directory will be built and generate an -executable in the build directory. Note that you'll need c++14, but clang in -Mac OSX will understand that (and if not, you'll have to update Xcode). +executable in the build directory. Note that you'll need c++14, but clang in Mac +OSX will understand that (and if not, you'll have to update Xcode). The main +sourcefile (`src/main.cpp`) can also be built with c++11 (this is tested on some +commits on both Windows and linux). ## Java @@ -27,3 +41,8 @@ Mac OSX will understand that (and if not, you'll have to update Xcode). For now the java code, which acts as a bridge between LearnLib and this c++ tool, is included here. But it should earn its own repo at some point. Also, my javanese is a bit rusty... + + +## License + +See `LICENSE`