https://github.com/kuhlwasstolen/mafl-library
Useful tools for people interested in mathematics and computer science (with a focus on the latter)
https://github.com/kuhlwasstolen/mafl-library
automata automata-simulator command-line-tool computer-science dfa dfa-construction dfa-minimization formal-languages formal-languages-and-automata mathematics maths
Last synced: 17 days ago
JSON representation
Useful tools for people interested in mathematics and computer science (with a focus on the latter)
- Host: GitHub
- URL: https://github.com/kuhlwasstolen/mafl-library
- Owner: KUHLwasStolen
- License: mit
- Created: 2024-02-12T23:12:01.000Z (about 1 year ago)
- Default Branch: trunk
- Last Pushed: 2024-05-07T09:19:40.000Z (12 months ago)
- Last Synced: 2024-05-07T10:34:25.974Z (12 months ago)
- Topics: automata, automata-simulator, command-line-tool, computer-science, dfa, dfa-construction, dfa-minimization, formal-languages, formal-languages-and-automata, mathematics, maths
- Language: C
- Homepage:
- Size: 314 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mafl-library
Useful command line tools for people interested in mathematics and computer science (with a focus on the latter).
~~~
/////////////////////////////////////////////////////////////////////////////////
/// ///// //////////// //////////// /// /////////////
/// / /// / /////////// / /////////// ///////////// /////////////
/// // / // ////////// /// ////////// ///////////// /////////////
/// /// /// ///////// ///// ///////// ///////////// /////////////
/// //// //// //////// /////// //////// /// /////////////
/// /////////// /////// ///////// /////// ///////////// /////////////
/// /////////// ////// ////// ///////////// /////////////
/// /////////// ///// ///////////// ///// ///////////// /////////////
/// /////////// //// /////////////// //// ///////////// /////////////
/// /////////// /// ///////////////// /// ///////////// ///
/////////////////////////////////////////////////////////////////////////////////
~~~
1. [About](#about)
2. [Features](#features)
2.1 [Mathematics](#mathematics)
2.2 [Computer Science](#computer-science)
3. [Installing](#installing)
## About
`mafl` stands for '**MA**ths' and '**A**utomata, **F**ormal **L**anguages and computation'.
The project's aim is to implement everything I learned/learn at university about these two subjects and make it available in an open and easy-to-use library.
This does not mean that the project will be limited to this, but the basic idea is as stated above.
I am well aware that this is probably not the first tool for the terminal that provides this functionality. But this is mine and it serves more of an educational purpose than anything else.
Furthermore this project is also about practicing my current programming skills, not about finding the very best method of doing something.
*Of course contributions and all sorts of improvements or recommendations are still very welcome, this was just to clarify that this project is not about doing stuff 'THE easy way', but rather about figuring A way.*
Now that the scope of the project is clear let's dig into the details.
## Features
To get a detailed list of features run `mafl --help` after the [installation](#installing).
The following list provides a short and comprehensive overview.
And for an in-depth tutorial/explanation on how to use all features take a look into the [examples folder](/examples/).
*(Or follow the links in the following features list)*
### Mathematics
none at the moment :(
### Computer Science
**[DFA](/examples/DFA/)** *(Deterministic Finite Automaton)*
- Reads a DFA either from the command line or a previously stored file and then let's you test its functionality
- Stores configuration files for automata that you have created in the command line
- Minimizes a given DFA using the table-construction method
## Installing
Of course before you can use it, you need an executable file on your system. To get this I recommend downloading the source code from the `trunk` branch and then compiling it (with gcc) in its folder.
Run:
~~~
git clone https://github.com/KUHLwasStolen/mafl-library.git
cd mafl-library
gcc ./src/*.c -o mafl
// On Windows: .\src\*c -o mafl
~~~
*(gcc is recommended as the code gets tested with it, I cannot promise compatibility with other compilers)*
The `-o` flag specifies the name of the compiled file. You can change this if you want but then the documentation and all references in the program itself don't make sense anymore.
The compiled file should now be in your current working directory (not `src`).
Optional:
Move your compiled file to a folder that's included in your PATH variable and now you're ready to use it anywhere!
It basically works like any other command line tool:
Type `mafl --help` or `mafl -h` to get a detailed list of everything that the tool can do or type `mafl -?` to get a shorter version of this without explanations.
And last but not least: have fun with your new tool!
If you have questions/problems feel free to open a new issue.