kwik 1.19.2

A set of useful tools I use for my Ph.D. research.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

/*
 * Copyright (c) Kia Shakiba
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

use std::time::Duration;

use crate::genetic::chromosome::Chromosome;

/// The solution of a genetic run. Holds the chromosome of the fittest
/// individual, the number of generations processed during the run, and the
/// total duration of the run.
pub struct GeneticSolution<C>
where
	C: Chromosome,
{
	chromosome: C,

	generations: u64,
	mutations:   u64,

	runtime: Duration,
}

impl<C> GeneticSolution<C>
where
	C: Chromosome,
{
	pub fn new(chromosome: C, generations: u64, mutations: u64, runtime: Duration) -> Self {
		GeneticSolution {
			chromosome,

			generations,
			mutations,

			runtime,
		}
	}

	/// Returns a reference to the fittest individual's chromosome.
	#[inline]
	pub fn chromosome(&self) -> &C {
		&self.chromosome
	}

	/// Returns the number of generations processed during the run.
	#[inline]
	pub fn generations(&self) -> u64 {
		self.generations
	}

	/// Returns the total number of mutations that occurred during the run.
	#[inline]
	pub fn mutations(&self) -> u64 {
		self.mutations
	}

	/// Returns the total runtime of the run.
	#[inline]
	pub fn runtime(&self) -> Duration {
		self.runtime
	}
}