Update docs for Evaluator about genalgo

[PawelDabrowski83]

Added checkboxes in first message of this topic.

[PawelDabrowski83]

One case where we can use calculateFitness is if we want to check Gene fitness without modyfing state of the object. For example we have multiple variants of Evaluator interface and want to compare fitness values calculated by them.

But I would argue that it is only a theoretical exercise, because value spread between 0-1 in each Evaluator impl. can be different and sometimes result 0.85 may indicate close match, and on another implementation the same result can indicate very weak match.

[KamilKamilS]

I have created docs in this way that Evaluator has a private method calculateFitness() only to calculate fitness and return a float. and setFitness() which is a public method and uses calculated fitness from the previous method and set I to a given gene. So I want just to split setFitness() method into two methods first calculate and then setFitness() method.

[KamilKamilS]

But maybe it is not needed because the method setFitness() that you have created is not so complex and maybe it can stay as it is now implemented

[PawelDabrowski83]

I was looking at our current diagram, which states that both methods are public, marked with plus sign.

[KamilKamilS]

Ok right my bad. Docs have no info about private method

[PawelDabrowski83]

Before advancing this issue, we might resolve #70

[KamilKamilS]

Additionally, I noticed that currently docs don't have a diagram with the evaluator. So updated diagram need to be added.

[PawelDabrowski83]

• Update Evaluator description
• Update class names
• Update diagram
• Update style for consistency (blockquote)