Merge pull request #16 from cicirello/cite-asec-2023

cicirello · web-flow · commit cb44621d72b1 · 2023-11-27T17:03:13.000-05:00
Updated documentation with ASEC 2023 citation
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,22 @@
+cff-version: "1.2.0"
+message: "If you use this software, please cite the article from preferred-citation."
+authors: 
+- family-names: "Cicirello"
+  given-names: "Vincent A"
+  orcid: "https://orcid.org/0000-0003-1072-8559"
+title: "An Analysis of an Open Source Binomial Random Variate Generation Algorithm"
+license: "GPL-3.0-or-later"
+url: "https://github.com/cicirello/btpe-iterations"
+preferred-citation:
+  type: article
+  authors:
+  - family-names: "Cicirello"
+    given-names: "Vincent A"
+    orcid: "https://orcid.org/0000-0003-1072-8559"
+  doi: "10.3390/ASEC2023-15349"
+  journal: "Engineering Proceedings"
+  title: "An Analysis of an Open Source Binomial Random Variate Generation Algorithm"
+  year: 2023
+  volume: 56
+  issue: 1
+  start: 86
diff --git a/README.md b/README.md
@@ -5,9 +5,9 @@ Copyright &copy; 2023 Vincent A. Cicirello
 This repository contains code to reproduce the experiments, and analysis of 
 experimental data, from the following paper:
 
-> Vincent A. Cicirello. 2023. An Analysis of an Open Source Binomial Random Variate Generation Algorithm, *Engineering Proceedings*, Accepted pending publication.
+> Vincent A. Cicirello. 2023. [An Analysis of an Open Source Binomial Random Variate Generation Algorithm](https://www.cicirello.org/publications/engproc-56-00086.pdf), *Engineering Proceedings*, 56(1), Article 86, October 2023. doi:[10.3390/ASEC2023-15349](https://doi.org/10.3390/ASEC2023-15349).
 
-| __Related Publication__ |  |
+| __Related Publication__ | [![doi:10.3390/ASEC2023-15349](doi.svg)](https://doi.org/10.3390/ASEC2023-15349) |
 | :--- | :--- |
 | __License__ | [![GitHub](https://img.shields.io/github/license/cicirello/cycle-mutation-experiments)](LICENSE) |
 | __Packages and Releases__ |  |
diff --git a/doi.svg b/doi.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="214" height="20" role="img" aria-label="EngProc: 10.3390/ASEC2023-15349"><title>EngProc: 10.3390/ASEC2023-15349</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="214" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="55" height="20" fill="#555"/><rect x="55" width="159" height="20" fill="#4c1"/><rect width="214" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="285" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="450">EngProc</text><text x="285" y="140" transform="scale(.1)" fill="#fff" textLength="450">EngProc</text><text aria-hidden="true" x="1335" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="1490">10.3390/ASEC2023-15349</text><text x="1335" y="140" transform="scale(.1)" fill="#fff" textLength="1490">10.3390/ASEC2023-15349</text></g></svg>
diff --git a/pom.xml b/pom.xml
@@ -9,10 +9,12 @@
 	<version>1.0.0</version>
 	<packaging>jar</packaging>
   
-	<name>Analysis of iterations of BTPE algorithm for binomial random variate generation</name>
+	<name>An Analysis of an Open Source Binomial Random Variate Generation Algorithm</name>
 	
 	<description>This package contains Java code to reproduce the experiments
-	of ADD-DETAILS-LATER-RELATED-TO-ARTICLE.
+	of the following article: Vincent A. Cicirello. 2023. An Analysis of an 
+	Open Source Binomial Random Variate Generation Algorithm, Engineering Proceedings, 
+	56(1), Article 86, October 2023. doi:10.3390/ASEC2023-15349.
 	</description>
 	
 	<url>https://github.com/cicirello/btpe-iterations</url>
@@ -23,7 +25,7 @@
 		<url>https://www.gnu.org/licenses/gpl-3.0.en.html</url>
 		<distribution>repo</distribution>
 		<comments>
-		Analysis of iterations of BTPE algorithm for binomial random variate generation.
+		An Analysis of an Open Source Binomial Random Variate Generation Algorithm.
 		Copyright (C) 2023 Vincent A. Cicirello.
  
 		This program is free software: you can redistribute it and/or modify
@@ -238,8 +240,8 @@
 				<configuration>
 					<failOnWarnings>true</failOnWarnings>
 					<failOnError>true</failOnError>
-					<windowtitle>Analysis of iterations of BTPE algorithm for binomial random variate generation</windowtitle>
-					<doctitle>Analysis of iterations of BTPE algorithm for binomial random variate generation</doctitle>
+					<windowtitle>An Analysis of an Open Source Binomial Random Variate Generation Algorithm</windowtitle>
+					<doctitle>An Analysis of an Open Source Binomial Random Variate Generation Algorithm</doctitle>
 					<author>true</author>
 					<version>false</version>
 					<nosince>true</nosince>
diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java
@@ -1,5 +1,5 @@
 /*
- * Analysis of iterations of BTPE algorithm for binomial random variate generation.
+ * An Analysis of an Open Source Binomial Random Variate Generation Algorithm.
  * Copyright (C) 2023 Vincent A. Cicirello
  *
  * This program is free software: you can redistribute it and/or modify
@@ -19,7 +19,11 @@
 /**
  * Code to reproduce the experiments from the following article:
  *
- * <p>INSERT DETAILS HERE LATER
+ * <p>Vincent A. Cicirello. 2023. <a
+ * href="https://www.cicirello.org/publications/engproc-56-00086.pdf">An Analysis of an Open Source
+ * Binomial Random Variate Generation Algorithm</a>. <i>Engineering Proceedings</i>, 56(1), Article
+ * 86, October 2023. doi:<a
+ * href="https://doi.org/10.3390/ASEC2023-15349">10.3390/ASEC2023-15349</a>.
  *
  * @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, <a
  *     href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>
diff --git a/src/main/java/org/cicirello/experiments/btpe/CountIterationsBTPE.java b/src/main/java/org/cicirello/experiments/btpe/CountIterationsBTPE.java
@@ -1,5 +1,5 @@
 /*
- * Analysis of iterations of BTPE algorithm for binomial random variate generation.
+ * An Analysis of an Open Source Binomial Random Variate Generation Algorithm.
  * Copyright (C) 2023 Vincent A. Cicirello
  *
  * This program is free software: you can redistribute it and/or modify
@@ -26,7 +26,11 @@
 /**
  * Code to reproduce the experiments from the following article:
  *
- * <p>INSERT DETAILS HERE LATER
+ * <p>Vincent A. Cicirello. 2023. <a
+ * href="https://www.cicirello.org/publications/engproc-56-00086.pdf">An Analysis of an Open Source
+ * Binomial Random Variate Generation Algorithm</a>. <i>Engineering Proceedings</i>, 56(1), Article
+ * 86, October 2023. doi:<a
+ * href="https://doi.org/10.3390/ASEC2023-15349">10.3390/ASEC2023-15349</a>.
  *
  * @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, <a
  *     href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>
diff --git a/src/main/python/ExpectedIterationsBTPE.py b/src/main/python/ExpectedIterationsBTPE.py
@@ -1,4 +1,4 @@
-# Analysis of iterations of BTPE algorithm for binomial random variate generation.
+# An Analysis of an Open Source Binomial Random Variate Generation Algorithm.
 # Copyright (C) 2023 Vincent A. Cicirello
 #
 # This program is free software: you can redistribute it and/or modify
diff --git a/src/main/python/analyze.py b/src/main/python/analyze.py
@@ -1,4 +1,4 @@
-# Analysis of iterations of BTPE algorithm for binomial random variate generation.
+# An Analysis of an Open Source Binomial Random Variate Generation Algorithm.
 # Copyright (C) 2023 Vincent A. Cicirello
 #
 # This program is free software: you can redistribute it and/or modify
diff --git a/src/main/python/findmax.py b/src/main/python/findmax.py
@@ -1,4 +1,4 @@
-# Analysis of iterations of BTPE algorithm for binomial random variate generation.
+# An Analysis of an Open Source Binomial Random Variate Generation Algorithm.
 # Copyright (C) 2023 Vincent A. Cicirello
 #
 # This program is free software: you can redistribute it and/or modify

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Analysis of iterations of BTPE algorithm for binomial random variate generation.`
	`2`	`+ * An Analysis of an Open Source Binomial Random Variate Generation Algorithm.`
`3`	`3`	`* Copyright (C) 2023 Vincent A. Cicirello`
`4`	`4`	`*`
`5`	`5`	`* This program is free software: you can redistribute it and/or modify`
`@@ -19,7 +19,11 @@`
`19`	`19`	`/**`
`20`	`20`	`* Code to reproduce the experiments from the following article:`
`21`	`21`	`*`
`22`		`- * <p>INSERT DETAILS HERE LATER`
	`22`	`+ * <p>Vincent A. Cicirello. 2023. <a`
	`23`	`+ * href="https://www.cicirello.org/publications/engproc-56-00086.pdf">An Analysis of an Open Source`
	`24`	`+ * Binomial Random Variate Generation Algorithm</a>. <i>Engineering Proceedings</i>, 56(1), Article`
	`25`	`+ * 86, October 2023. doi:<a`
	`26`	`+ * href="https://doi.org/10.3390/ASEC2023-15349">10.3390/ASEC2023-15349</a>.`
`23`	`27`	`*`
`24`	`28`	`* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, <a`
`25`	`29`	`* href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Analysis of iterations of BTPE algorithm for binomial random variate generation.`
	`1`	`+# An Analysis of an Open Source Binomial Random Variate Generation Algorithm.`
`2`	`2`	`# Copyright (C) 2023 Vincent A. Cicirello`
`3`	`3`	`#`
`4`	`4`	`# This program is free software: you can redistribute it and/or modify`