Auto64Fto32F

Auto64Fto32F: A minimalist library for converting double (64-bit) numerical Java code into float (32-bit).

This library is used to create applications that can convert code written with 64-bit floats (i.e. doubles) into 32-bit float code. This is done by performing specially designed keyword replacements. No special template language is required. However, a special coding style is required.

1. Recusively search input directory for files ending in "_F64.java"
2. Create a new file with the ending "_F32.java"
3. Perform REGEX/keyword swap and save results to output file

The suffice it searches for can be change from '_F64' into other valid string.

Transformation Process

The process of converting double math into float math is fairly simple. For example, it does not know if the text it is examining is inside a comment or not. It works by applying a carefully crafted sequence of keyword replacement using regex.

Processing Steps:

1. Copies over the copyright at the start of the file unmodified.

   This is accomplished by simply copying everything until a line with 4 characters and line[2] == '/' is encountered.

2. Break the remainder of the document into words and white space.

   White space is written to the output unmodified

3. Words are transformed by applying four separate sets of filters in the following order.

• REGEX matching: If part of the word matches a regex that portion of the word is replaced with the replacement text
• Starts with matching: If the word begins with the specified text it is replaced with the replacement text.
• double replacement: An internally specified regex is used to detect doubles (e.g. 45.0 or 4.) and convert it into a float
• After REGEX matching: Another round of regex matching. Can be used to undo an earlier modification

See next section below for how to programmically specify each type of text replacement.

Default Replacements

In the constructor of ConvertFile32From64 there is a flag to use the default replacements. If set to true this will be added automatically.

replacePattern("double", "float");
replacePattern("Double", "Float");
replacePattern("_F64", "_F32");

replaceStartsWith("Math.", "(float)Math.");
replaceStartsWith("-Math.", "(float)-Math.");

Turning Off Replacement

The easiest way to turn off a rule is to include /**/ in front of the token. See the example section. When that can't be done then you can specify custom rules in the file itself. One situation where the /**/ override won't work is if you need to do it in an import statement and use an IDE like IntelliJ. IntelliJ will automatically remove the pointless comment in that situation.

There are two ways to specify a rule for an individual file. 1) Ignore keywords. 2) Remove comment. What the line below does is it will ignore/not modify anything which matches the keyword after the word ignore. One use case for this is when you have an interface which specify a double type and the float version of the code needs to conform to that interface.

//CUSTOM ignore Box3D_F64

If a line starts with "//NOFILTER" those letters exactly will be removed from the converted file.

Code Examples

The following is an example of code which is to be transformed. It's Java regular code, with some special syntax and some restrictions on what functions/variables can be named.

Original Code:

/**/double moo = /**/Math.cos(0.5);
double foo = 1.6*bar + Math.exp(6) + (double)moo;

Converted Code:

/**/double moo = /**/Math.cos(0.5);
float foo = 1.6f*bar + (float)Math.exp(6) + (float)moo;

The sequence /**/double is searched for and ignored, thus it will remain a double in the floating point code. /**/Math will not be typecasted because there is no space in front of Math. More on that Math issue later.

To avoid a compile time exception in the float code the variable 'moo' needs to be converted into a float. That is accomplished through a gratuitous (double) typecast.

Gotchas

double foo = 1.6*bar +Math.exp(6);

float foo = 1.6f*bar +Math.exp(6);

Notice how the converted code will generate a compile time error since Math.exp() returns a double? Math operators require a space in front. While annoying this easily handles edge cases that a straight forward keyword swap can't handle. The correct way to write the code and what the conversion looks like is shown below.

double foo = 1.6*bar + Math.exp(6);

float foo = 1.6f*bar + (float)Math.exp(6);

License

This software is released under multiple licenses; Unlicense and MIT License. You may choose one or all of these licenses when using this software. For specific details on Unlicense and MIT License look at the UNLICENSE and LICENSE-MIT files, respectively.

Author

This software is written by Peter Abeles