Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tamchow committed Dec 3, 2015
1 parent f380ca8 commit ffd9aee
Showing 1 changed file with 19 additions and 15 deletions.
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,34 @@
# FractalGenerator
<html>
A <b>Java</b> fractal generator (currently without an input/configuration ui, soon through a .ini file),
that implements display of custom functions,
with constant declaration processing, in both Mandelbrot and Julia modes.
There are 6 different colouring schemes, 5 of which use iteration renormalization with linear interpolation for emphasis on outer regions,
and 1 which renders in grayscale for emphasis on inner regions.
A <b>Java</b> fractal generator (currently without an input/configuration UI, soon through a configuration file),
that implements display of custom functions, with constant declaration processing, in both Mandelbrot and Julia modes.

Newton Mode only supports simple polynomials with complex exponents and coefficients allowed, but the polynomial must be in a special format, which is documented in .idea/description.html

There are 9 different colouring schemes, 4 have linear interpolation, 3 have Catmull-Rom Spline interpolation and 2 which directly render in grayscale for emphasis on inner regions.

The spline-interpolant methods are the standard ones of Triangle Area Inequality, Curvature Average and Stripe Average.

The linear interpolant methods have the 2 Newton fractal special modes, and the division and multiplication direct generation modes.

Resolution of the fractal is preferred to be in 2m+1x2n+1 format for proper symmetry.

<p>
NOTES:
The fractal generator has the basic framework for being extensible and being multithreaded, but it is currently single-threaded since I'm not
really sure about how well or correctly I can handle multithreading.
Also,there is full support for zoom, but renders after zoom are slow if the input resolution is higher than 401x401 and very slow above 801x801.
Not really sure about threaded prerenders, will have to ask someone for help with it.
The fractal generator has the basic framework for being extensible and being multithreaded, but it is currently single-threaded since I'm not really sure about how well or correctly I can handle multithreading.

Also,there is full support for zoom, but renders after zoom are slow for higher base precision values. As a thumb rule, for quadrupling total resolution, double base precision for best results.
</p>

<p>
There is also an included image viewer, which can also display fractals.
There is support for elementary image transitions from top,bottom,left and right.
However, saving of the fractal image and zooming in the viewer is not currently supported(at the top of my TODO list).
NOTE:
Both are supported now in code but are untested.
I will soon implement configuring fractal display through a configuration file.
NOTE:
This has been implemented, but is not integrated anywhere in the main program.
Image display configuration is a stickler for format, but is pretty much ready.
Same for the fractal configuration.

This has been implemented, and is integrated into the main program, with a fractal configuration file path being the only accepted argument.

Image and Fractal display configuration files are a stickler for format, but do support inline comments with "#", as in .ini files.
</p>

<p>
Expand Down

0 comments on commit ffd9aee

Please sign in to comment.