Skip to content

Commit

Permalink
#880: Prepare for using code snippet tag.
Browse files Browse the repository at this point in the history 
Signed-off-by: Franz Wilhelmstötter <franz.wilhelmstoetter@gmail.com>
  • Loading branch information
@jenetics
jenetics committed Aug 31, 2023
1 parent 163d0c0 commit 0879c55
Show file tree
Hide file tree
Showing 13 changed files with 40 additions and 40 deletions.
2 changes: 1 addition & 1 deletion jenetics.ext/src/main/java/io/jenetics/ext/SingleNodeCrossover.java
View file
Expand Up @@ -61,7 +61,7 @@
* │ └── l
* ├── i
* └── j
* }</pre>
* } </pre>
*
* @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
* @version 5.0
Expand Down
2 changes: 1 addition & 1 deletion jenetics.ext/src/main/java/io/jenetics/ext/engine/ConcatEngine.java
View file
Expand Up @@ -51,7 +51,7 @@
* ------>| Engine 1 |------------>| Engine 2 |----------->
* | | Result | | Result
* +------------+ +------------+
* }</pre>
* } </pre>
*
* The sketch above shows how the engine concatenation works. In this example,
* the evolution stream of the first engine is evaluated until it terminates.
Expand Down
2 changes: 1 addition & 1 deletion jenetics.ext/src/main/java/io/jenetics/ext/engine/CyclicEngine.java
View file
Expand Up @@ -52,7 +52,7 @@
* | |
* +------------------------------<------------------------+
* Result
* }</pre>
* } </pre>
*
* The {@code CyclicEngine} allows to do a broad search-fine search-cycle
* as long as you want.
Expand Down
8 changes: 4 additions & 4 deletions jenetics.ext/src/main/java/io/jenetics/ext/rewriting/TreeRewriteRule.java
View file
Expand Up @@ -50,14 +50,14 @@
* <pre> {@code
* add($x,0) -> $x
* mul($x,1) -> $x
* }</pre>
* } </pre>
* The <em>substitution</em> pattern may only use variables, already defined in
* the <em>match</em> pattern. So, the creation of the following rewrite rule s
* would lead to an {@link IllegalArgumentException}:
* <pre> {@code
* add($x,0) -> $y
* mul(0,1) -> mul($x,1)
* }</pre>
* } </pre>
*
* @see <a href="https://en.wikipedia.org/wiki/Rewriting#Term_rewriting_systems">
* Tree rewriting systems</a>
Expand Down Expand Up @@ -185,7 +185,7 @@ public String toString() {
* <pre> {@code
* add($x,0) -> $x
* mul($x,1) -> $x
* }</pre>
* } </pre>
*
* @param <V> the tree node type
* @param rule the rewrite rule
Expand Down Expand Up @@ -223,7 +223,7 @@ public static <V> TreeRewriteRule<V> parse(
* <pre> {@code
* add($x,0) -> $x
* mul($x,1) -> $x
* }</pre>
* } </pre>
*
* @param rule the rewrite rule
* @return a new rewrite rule, compiled from the given rule string
Expand Down
4 changes: 2 additions & 2 deletions jenetics.prog/src/main/java/io/jenetics/prog/op/MathExpr.java
View file
Expand Up @@ -126,7 +126,7 @@ public final class MathExpr
* pow(0,$x) -> 0
* pow($x,1) -> $x
* pow(1,$x) -> 1
* }</pre>
* } </pre>
*
* @since 5.0
*/
Expand Down Expand Up @@ -458,7 +458,7 @@ public static MathExpr parse(final String expression) {
* │ │ └── 5.0
* │ └── 4.0
* └── 6.0
* }</pre>
* } </pre>
*
* @param expression the expression string
* @return the parsed expression tree
Expand Down
2 changes: 1 addition & 1 deletion jenetics.prog/src/main/java/io/jenetics/prog/op/Var.java
View file
Expand Up @@ -214,7 +214,7 @@ public static <T> Var<T> of(final String name) {
* x[0]
* y[3]
* my_var[4]
* }</pre>
* } </pre>
*
* If no variable <em>index</em> is encoded in the name, a variable with
* index 0 is created.
Expand Down
18 changes: 9 additions & 9 deletions jenetics.xml/src/main/java/io/jenetics/xml/Readers.java
View file
Expand Up @@ -77,7 +77,7 @@ private Readers() {}
* <b>XML</b>
* <pre> {@code
* <bit-chromosome length="20" ones-probability="0.5">11100011101011001010</bit-chromosome>
* }</pre>
* } </pre>
* }
*/
public static final class BitChromosome {
Expand Down Expand Up @@ -130,7 +130,7 @@ public static io.jenetics.BitChromosome read(final InputStream in)
* <valid-alleles>ABCDEFGHIJKLMNOPQRSTUVWXYZ<valid-alleles>
* <alleles>ASDF</alleles>
* </character-chromosome>
* }</pre>
* } </pre>
*/
public static final class CharacterChromosome {
private CharacterChromosome() {}
Expand Down Expand Up @@ -189,7 +189,7 @@ public static io.jenetics.CharacterChromosome read(final InputStream in)
* <allele>ggg</allele>
* </alleles>
* </root-name>
* }</pre>
* } </pre>
*/
public static final class BoundedChromosome {
private BoundedChromosome() {}
Expand Down Expand Up @@ -267,7 +267,7 @@ Reader<C> reader(
* <allele>-88668137</allele>
* </alleles>
* </int-chromosome>
* }</pre>
* } </pre>
*/
public static final class IntegerChromosome {
private IntegerChromosome() {}
Expand Down Expand Up @@ -330,7 +330,7 @@ public static io.jenetics.IntegerChromosome read(final InputStream in)
* <allele>6053786736809578435</allele>
* </alleles>
* </long-chromosome>
* }</pre>
* } </pre>
*/
public static final class LongChromosome {
private LongChromosome() {}
Expand Down Expand Up @@ -393,7 +393,7 @@ public static io.jenetics.LongChromosome read(final InputStream in)
* <allele>0.43947528327497376</allele>
* </alleles>
* </double-chromosome>
* }</pre>
* } </pre>
*/
public static final class DoubleChromosome {
private DoubleChromosome() {}
Expand Down Expand Up @@ -457,7 +457,7 @@ public static io.jenetics.DoubleChromosome read(final InputStream in)
* </valid-alleles>
* <order>2 1 3 5 4</order>
* </permutation-chromosome>
* }</pre>
* } </pre>
*/
public static final class PermutationChromosome {
private PermutationChromosome() {}
Expand Down Expand Up @@ -552,7 +552,7 @@ private PermutationChromosome() {}
* <alleles>
* </double-chromosome>
* </genotype>
* }</pre>
* } </pre>
*/
public static final class Genotype {
private Genotype() {}
Expand Down Expand Up @@ -665,7 +665,7 @@ private Genotype() {}
* </double-chromosome>
* </genotype>
* </genotypes>
* }</pre>
* } </pre>
*/
public static final class Genotypes {
private Genotypes() {}
Expand Down
20 changes: 10 additions & 10 deletions jenetics.xml/src/main/java/io/jenetics/xml/Writers.java
View file
Expand Up @@ -89,7 +89,7 @@ private Writers() {}
* <b>XML output</b>
* <pre> {@code
* <bit-chromosome length="20" ones-probability="0.5">11100011101011001010</bit-chromosome>
* }</pre>
* } </pre>
*
* @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
* @version 3.9
Expand Down Expand Up @@ -161,7 +161,7 @@ public static void write(
* <valid-alleles>ABCDEFGHIJKLMNOPQRSTUVWXYZ<valid-alleles>
* <alleles>ASDF</alleles>
* </character-chromosome>
* }</pre>
* } </pre>
*/
public static final class CharacterChromosome {
private CharacterChromosome() {}
Expand Down Expand Up @@ -252,7 +252,7 @@ public static void write(
* <allele>ggg</allele>
* </alleles>
* </root-name>
* }</pre>
* } </pre>
*/
public static final class BoundedChromosome {
private BoundedChromosome() {}
Expand Down Expand Up @@ -322,7 +322,7 @@ Writer<C> writer(
* <allele>-88668137</allele>
* </alleles>
* </int-chromosome>
* }</pre>
* } </pre>
*/
public static final class IntegerChromosome {
private IntegerChromosome() {}
Expand Down Expand Up @@ -443,7 +443,7 @@ public static void write(
* <allele>6053786736809578435</allele>
* </alleles>
* </long-chromosome>
* }</pre>
* } </pre>
*/
public static final class LongChromosome {
private LongChromosome() {}
Expand Down Expand Up @@ -561,7 +561,7 @@ public static void write(
* <allele>0.43947528327497376</allele>
* </alleles>
* </double-chromosome>
* }</pre>
* } </pre>
*/
public static final class DoubleChromosome
//extends WriterProvider<io.jenetics.DoubleChromosome>
Expand Down Expand Up @@ -691,7 +691,7 @@ public static void write(
* </valid-alleles>
* <order>2 1 3 5 4</order>
* </permutation-chromosome>
* }</pre>
* } </pre>
*/
public static final class PermutationChromosome {
private PermutationChromosome() {}
Expand Down Expand Up @@ -766,7 +766,7 @@ private static String toAlleleTypeName(
* </valid-alleles>
* <order>13 12 4 6 8 14 7 2 11 5 3 0 9 10 1</order>
* </permutation-chromosome>
* }</pre>
* } </pre>
*
* @param <A> the allele type
* @return a new permutation chromosome writer
Expand Down Expand Up @@ -921,7 +921,7 @@ public static <A> void write(
* <alleles>
* </double-chromosome>
* </genotype>
* }</pre>
* } </pre>
*/
public static final class Genotype {
private Genotype() {}
Expand Down Expand Up @@ -1080,7 +1080,7 @@ void write(
* </double-chromosome>
* </genotype>
* </genotypes>
* }</pre>
* } </pre>
*/
public static final class Genotypes {
private Genotypes() {}
Expand Down
12 changes: 6 additions & 6 deletions jenetics.xml/src/main/java/io/jenetics/xml/stream/Reader.java
View file
Expand Up @@ -218,7 +218,7 @@ public String toString() {
* "element",
* attr("length").map(Integer::parseInt)
* );
* }</pre>
* } </pre>
*
* @param name the attribute name
* @return an attribute reader
Expand All @@ -242,7 +242,7 @@ public static Reader<String> attr(final String name) {
* "element",
* text().map(Integer::parseInt)
* );
* }</pre>
* } </pre>
*
* @return an element text reader
*/
Expand Down Expand Up @@ -271,7 +271,7 @@ public static Reader<String> text() {
* attr("name"),
* text().map(Integer::parseInt)
* );
* }</pre>
* } </pre>
*
* @param generator the generator function, which build the result object
* from the given parameter array
Expand Down Expand Up @@ -301,7 +301,7 @@ public static <T> Reader<T> elem(
* the given parent element {@code name}.
* <p>
* <b>XML</b>
* <pre> {@code <min><property name="size">1234<property></min>}</pre>
* <pre> {@code <min><property name="size">1234<property></min>} </pre>
*
* <b>Reader definition</b>
* <pre>{@code
Expand Down Expand Up @@ -355,7 +355,7 @@ public static <T> Reader<T> elem(
* <property>-957346595</property>
* <property>-88668137</property>
* </properties>
* }</pre>
* } </pre>
*
* <b>Reader definition</b>
* <pre>{@code
Expand All @@ -365,7 +365,7 @@ public static <T> Reader<T> elem(
* "properties",
* elems(elem("property", text().map(Integer::parseInt)))
* );
* }</pre>
* } </pre>
*
* @param reader the child element reader
* @param <T> the element type
Expand Down
4 changes: 2 additions & 2 deletions jenetics.xml/src/main/java/io/jenetics/xml/stream/Writer.java
View file
Expand Up @@ -39,7 +39,7 @@
* <allele>-88668137</allele>
* </alleles>
* </int-chromosome>
* }</pre>
* } </pre>
*
* The XML has been written by the following {@code Writer} definition.
*
Expand Down Expand Up @@ -270,7 +270,7 @@ static <T> Writer<Iterable<T>> elems(final Writer<? super T> writer) {
*
* <pre> {@code
* <?xml version="1.0" encoding="UTF-8"?>
* }</pre>
* } </pre>
*
* @param writer the root element writer
* @param <T> the writer data type
Expand Down
2 changes: 1 addition & 1 deletion jenetics/src/main/java/io/jenetics/BitChromosome.java
View file
Expand Up @@ -56,7 +56,7 @@
* Array: |11110011|10011101|01000000|00101010|
* | | | |
* Bit: 23 15 7 0
* }</pre>
* } </pre>
*
* @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
* @since 1.0
Expand Down
2 changes: 1 addition & 1 deletion jenetics/src/main/java/io/jenetics/UniformCrossover.java
View file
Expand Up @@ -37,7 +37,7 @@
* +-+-+---+-+-+-+-+---+-+-+---+
* | a | b | c | d | e | f | g |
* +---+---+---+---+---+---+---+
* }</pre>
* } </pre>
* The probability that two genes are swapped is controlled by the
* <i>swap-probability</i> ({@link #swapProbability()}), whereas the
* probability that a given individual is selected for crossover is defined by
Expand Down
2 changes: 1 addition & 1 deletion jenetics/src/main/java/io/jenetics/internal/collection/BitArray.java
View file
Expand Up @@ -38,7 +38,7 @@
* Array: |11110011|10011101|01000000|00101010|
* | | | |
* Bit: 23 15 7 0
* }</pre>
* } </pre>
*
* @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
* @since 7.0
Expand Down

0 comments on commit 0879c55

Please sign in to comment.