Skip to content

Commit b1924a0

Browse files
dobriyanchikdobriyanchik
authored
Merge pull request #1 from chaossoftware/task/chaossoft-adaptation
Package adapted to be part of chaossoft product
2 parents ceba5e3 + 8aa25a7 commit b1924a0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+858
-2297
lines changed

‎LICENSE.txt‎

Lines changed: 201 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,201 @@
1-
MIT License
2-
3-
Copyright (c) 2021 - 2022 Vitaliy Dobriyan
4-
5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
11-
12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
14-
15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ChaosSoft.GeneticAlgorithm
2+
3+
Implementation of genetic algorithm.
4+
5+
Entities:
6+
* Population
7+
* Interface for chromosomes
8+
9+
Engines:
10+
* GeneticEngine (single step evolution)
11+
* BulkGeneticEngine (multiple steps evolution)
12+
13+
Base of evolution engine

‎icon.jpg‎

-5.86 KB
Binary file not shown.

‎icon.png‎

22 KB
Loading

‎pack.bat‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
@echo off
2+
set PKG=ChaosSoft.GeneticAlgorithm
3+
set PROJ_PATH=%cd%\src\%PKG%\%PKG%
4+
set VERSION=%1
5+
set OUT_DIR=%2
6+
7+
dotnet pack %PROJ_PATH%.csproj -o %OUT_DIR% -c Release -p:NuspecFile=%PROJ_PATH%.nuspec -p:Version=%VERSION%

src/SciML.sln renamed to src/ChaosSoft.GeneticAlgorithm.sln

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11

22
Microsoft Visual Studio Solution File, Format Version 12.00
3-
# Visual Studio Version 16
4-
VisualStudioVersion = 16.0.29424.173
3+
# Visual Studio Version 17
4+
VisualStudioVersion = 17.4.33110.190
55
MinimumVisualStudioVersion = 10.0.40219.1
6-
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SciML.GeneticAlgorithm", "SciML.GeneticAlgorithm\SciML.GeneticAlgorithm.csproj", "{78C87E59-2C1A-4F30-8087-0A63F6ADD577}"
7-
EndProject
8-
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SciML.NeuralNetwork", "SciML.NeuralNetwork\SciML.NeuralNetwork.csproj", "{D8D24A3E-0B5D-454A-AA8D-8A4016D7F61E}"
6+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ChaosSoft.GeneticAlgorithm", "ChaosSoft.GeneticAlgorithm\ChaosSoft.GeneticAlgorithm.csproj", "{78C87E59-2C1A-4F30-8087-0A63F6ADD577}"
97
EndProject
108
Global
119
GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -17,10 +15,6 @@ Global
1715
{78C87E59-2C1A-4F30-8087-0A63F6ADD577}.Debug|Any CPU.Build.0 = Debug|Any CPU
1816
{78C87E59-2C1A-4F30-8087-0A63F6ADD577}.Release|Any CPU.ActiveCfg = Release|Any CPU
1917
{78C87E59-2C1A-4F30-8087-0A63F6ADD577}.Release|Any CPU.Build.0 = Release|Any CPU
20-
{D8D24A3E-0B5D-454A-AA8D-8A4016D7F61E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
21-
{D8D24A3E-0B5D-454A-AA8D-8A4016D7F61E}.Debug|Any CPU.Build.0 = Debug|Any CPU
22-
{D8D24A3E-0B5D-454A-AA8D-8A4016D7F61E}.Release|Any CPU.ActiveCfg = Release|Any CPU
23-
{D8D24A3E-0B5D-454A-AA8D-8A4016D7F61E}.Release|Any CPU.Build.0 = Release|Any CPU
2418
EndGlobalSection
2519
GlobalSection(SolutionProperties) = preSolution
2620
HideSolutionNode = FALSE

‎src/ChaosSoft.GeneticAlgorithm/BulkGeneticEngine.cs‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
using System;
2+
3+
namespace ChaosSoft.GeneticAlgorithm;
4+
5+
/// <summary>
6+
/// Wrapper over <see cref="GeneticEngine{C, T}"/> to perform iterative evolution process
7+
/// with ability to subscribe to iteration events.
8+
/// </summary>
9+
/// <typeparam name="C">cromosome type</typeparam>
10+
/// <typeparam name="T">fitness measure type</typeparam>
11+
public class BulkGeneticEngine<C, T> : GeneticEngine<C, T> where C : IChromosome<C> where T : IComparable<T>
12+
{
13+
private bool terminate = false;
14+
15+
/// <summary>
16+
/// Initializes a new instance of the <see cref="BulkGeneticEngine{C, T}"/> class
17+
/// based on initial population and fitness function.
18+
/// </summary>
19+
/// <param name="population">initial population for evolution process</param>
20+
/// <param name="fitnessFunction">function to calculate chromosomes fitness</param>
21+
public BulkGeneticEngine(Population<C> population, IFitness<C, T> fitnessFunction)
22+
: base(population, fitnessFunction)
23+
{
24+
25+
}
26+
27+
/// <summary>
28+
/// Delegate for <see cref="OnIterate"/> event.
29+
/// </summary>
30+
/// <param name="engineInstance"></param>
31+
public delegate void GeneticIterationEvent(BulkGeneticEngine<C, T> engineInstance);
32+
33+
/// <summary>
34+
/// Event called after each evolution step execution.
35+
/// </summary>
36+
public event GeneticIterationEvent OnIterate;
37+
38+
/// <summary>
39+
/// Gets or sets evolution iteration.
40+
/// </summary>
41+
public int Iteration { get; protected set; } = 0;
42+
43+
/// <summary>
44+
/// Performs specified number of evolution steps (<see cref="GeneticEngine{C, T}.Evolve"/>)
45+
/// and calling <see cref="OnIterate"/> after each iteration.
46+
/// The operation could be terminated.
47+
/// </summary>
48+
/// <param name="iterations">number of iterations to perform</param>
49+
public void Evolve(int iterations)
50+
{
51+
terminate = false;
52+
53+
for (int i = 0; i < iterations; i++)
54+
{
55+
if (terminate)
56+
{
57+
break;
58+
}
59+
60+
Evolve();
61+
}
62+
}
63+
64+
/// <summary>
65+
/// Performs single evolution step (<see cref="GeneticEngine{C, T}.Evolve"/>)
66+
/// and calls <see cref="OnIterate"/> event.
67+
/// </summary>
68+
public override void Evolve()
69+
{
70+
base.Evolve();
71+
72+
Iteration++;
73+
74+
OnIterate?.Invoke(this);
75+
}
76+
77+
/// <summary>
78+
/// Terminates evolution process.
79+
/// </summary>
80+
public void Terminate() =>
81+
terminate = true;
82+
}

‎src/ChaosSoft.GeneticAlgorithm/ChaosSoft.GeneticAlgorithm.csproj‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<LangVersion>10.0</LangVersion>
5+
<TargetFrameworks>netstandard2.0;net6.0</TargetFrameworks>
6+
<NuspecProperties>version=$(Version)</NuspecProperties>
7+
</PropertyGroup>
8+
9+
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
10+
<DocumentationFile>bin\Release\ChaosSoft.GeneticAlgorithm.xml</DocumentationFile>
11+
</PropertyGroup>
12+
13+
<ItemGroup>
14+
<PackageReference Include="MersenneTwister" Version="1.0.6" />
15+
</ItemGroup>
16+
17+
</Project>

0 commit comments

Comments
 (0)