1 Star 2 Fork 0

周逸凡/ioaj

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

ioaj

介绍

智能算法Java框架(持续更新中)

框架内容

目前实现的优化算法有:

  • 基于进化机制
    • 遗传算法(GA)
  • 基于物理原理
    • 模拟退火算法(SAA)
    • 引力搜索算法(GSA)
  • 基于群体智能
    • 粒子群算法(PSO)
    • 蚁群算法(ACO)
    • 灰狼算法(GWO)
    • 布谷鸟算法(CS)
    • 人工蜂群算法(ABC)
    • 人工鱼群算法(AFSA)
    • 萤火虫算法(FA)

安装教程

可以先将项目下载到本地,然后执行 mvn install,这样就可以将项目添加到本地仓库中。使用时协上坐标即可

执行命令后,确认本地仓库有 ioaj-1.0-SNAPSHOT.pom 文件了,就说明添加成功了

<dependency>
    <groupId>com.github.zyf.ioaj</groupId>
    <artifactId>ioaj</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

使用说明

详细内容请参考文档,在document文件夹目录下,用浏览器打开index.html即可

有两种使用方法,一种是注解形式,一种是接口形式。

如果使用的是注解,例如

package org.example;

import constant.annotation.com.github.zyf.ioaj.AlgorithmType;
import external.annotation.com.github.zyf.ioaj.Export;
import external.annotation.com.github.zyf.ioaj.IOA;
import external.annotation.com.github.zyf.ioaj.ObjectFunction;

/**
 * @author zyf
 */
@IOA
public class TestClass {

    @ObjectFunction(type = AlgorithmType.PSO, varNum = 2, lb = {-15, -15}, ub = {15, 15})
    @Export(author = "zyf", title = "测试报告1")
    public Double apply(Double[] p) {
        return p[0] * p[0] + p[1] * p[1] - p[0] * p[1] - 10 * p[0] - 4 * p[1] + 60;
    }

    @ObjectFunction(type = AlgorithmType.SAA, varNum = 2, lb = {-15, -15}, ub = {15, 15})
    @Export(author = "zyf", title = "测试报告2")
    public Double apply2(Double[] p) {
        return p[0] * p[0] + p[1] * p[1] - p[0] * p[1] - 10 * p[0] - 4 * p[1] + 60;
    }

}

其中 @IOA 注解表示当前类是需要植入优化算法的类,添加该注解后后续操作方能有效; @ObjectFunction 注解表示当前方法是目标函数,输入必须的参数后,就可以把当前方法作为目标函数进行寻优; @Export 注解表示当前方法需要一些计算报告(在实现原理上,计算报告的计算和纯计算是分开来的),开发者可以根据需要,进行一些报告导出活动(不添加这个注解则无法导出报告)。

如果您不想使用注解,那么您的目标函数需要是 com/github/zyf/ioaj/algorithm/Function.java 类型(当然,这个接口是您需要实现的), 然后按照 com/github/zyf/ioaj/algorithm/Input.java 所定义的格式设置参数,接下来就可以选择您需要的算法运算器了。例如:

package org.example;

import algorithm.com.github.zyf.ioaj.Function;
import algorithm.com.github.zyf.ioaj.Input;
import swarmintelligence.algorithm.com.github.zyf.ioaj.PSO;

public class Test {

    public void main() {
        Function function = new Function() {
            @Override
            public double apply(double[] p) {
                return p[0] * p[0] + p[1] * p[1] - p[0] * p[1] - 10 * p[0] - 4 * p[1] + 60;
            }
        };
        double[] lb = {-15.0, -15.0};
        double[] ub = {15.0, 15.0};
        Input input = new Input(function, 2, lb, ub);
        PSO pso = new PSO(input);
        pso.go();
        System.out.println(pso.getOutput().toString());
    }
}

运行方法例如

package org.example;

import algorithm.com.github.zyf.ioaj.Output;
import processor.annotation.com.github.zyf.ioaj.IOAProcessor;

import java.util.Map;

/**
 * @author zyf
 */
public class Main {
    public static void main(String[] args) {
        // 扫描整个类,并打印计算结果
        Map<String, Output> outputList = IOAProcessor.execute(TestClass.class);
        for (Map.Entry<String, Output> entry : outputList.entrySet()) {
            System.out.println(entry.getKey() + "  " + entry.getValue().toString());
        }

        // 指定函数,打印计算结果
        Output output = IOAProcessor.execute(TestClass.class, "apply");
        System.out.println(output.toString());

        // 打印报告
        AbstractExport abstractExport = IOAProcessor.export(TestClass.class, "apply2");
        System.out.println(abstractExport.export());
    }
}

即使用 IOAProcessor 作为驱动, IOAProcessor.execute(Class clazz) 可以一键执行这个类的所有目标函数,返回的是以函数名为键、计算输出为值的HashMap。 也可以使用 IOAProcessor.execute(Class clazz, String methodName) 执行指定名称的函数。 对应地,使用 IOAProcessor.abstractExport(Class clazz) 可以一键导出这个类的所有算法计算报告; 使用 IOAProcessor.abstractExport(Class clazz, String methodName) 导出指定函数的算法计算报告。 具体用法可以参考文档。

参与贡献

如果您想对该项目做出一些贡献,您可以

  1. Fork 本仓库
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request

或者邮箱联系我:3399465887@qq.com

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

智能算法Java框架(持续更新中) 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Java
1
https://gitee.com/zyflzz/ioaj.git
git@gitee.com:zyflzz/ioaj.git
zyflzz
ioaj
ioaj
master

搜索帮助