mediocregopher/ginger
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added readme for mathgen

Browse Source
This commit is contained in:
Brian Picciano 2014-10-23 21:04:58 -04:00
parent 583e381ecb
commit 024e0d2bec
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
core/mathgen/README.md Normal file
View File

@ -0,0 +1,18 @@
# mathgen, or why I'm so so sorry
Go's type system is a double-edged sword, and the inner edge will definitely get
you when you go to do generic math. I opted against using the `reflect` library,
and instead went for codegen. So while the result is barely readable, it will at
least be somewhat faster, theoretically.
This module generates the `math.go` file which resides in the core library. The
`mathgen.tpl` file is where most of the magic happens. It is virtually
unreadable. The biggest reason for this is that I want it to be able to pass
through `go fmt` unphased, so that it doesn't end up getting changed back and
forth throughout the code's history.
## Running
You can run code gen by running `make gen` in the `core/` directory. The
`Makefile` in the root of the project should also reference this, so running
that in the root should also result in the file getting regenerated.