Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor, Optimize, Gradle Version, Documentation, and Tests #172

Merged
merged 33 commits into from
Jul 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
769e6a7
Update the Kotlin version to 1.9.0-Beta and add ExperimentalForeignAp…
devcrocod Jun 7, 2023
64c3db6
Update Dokka to version 1.8.20
devcrocod Jun 8, 2023
4a8e9fe
Refactor: extracted getters and setters to separate file and added ge…
devcrocod Jun 9, 2023
2906b45
Optimize code, remove unused imports, and add documentation
devcrocod Jun 9, 2023
27fd62e
Update suppress annotations and add inline info
devcrocod Jun 9, 2023
861256d
Optomize complex numbers and enhance documentation
devcrocod Jun 10, 2023
0a0950f
Return complex number from native code, optimize fitsInFloat, and imp…
devcrocod Jun 12, 2023
aa9642b
Refactor MultiArray getters and setters for generic dimension
devcrocod Jun 13, 2023
9f58fed
Add new utility functions and improve documentation
devcrocod Jun 13, 2023
b39f56c
Update Gradle version and remove unnecessary 'withJava()'
devcrocod Jun 13, 2023
730cefe
Update Nexus publishing configuration
devcrocod Jun 13, 2023
581e6dd
Improve error messages and remove unused code
devcrocod Jun 13, 2023
5ed3494
Refactor contentEquals for better readability
devcrocod Jun 14, 2023
8f983b3
Rename file and update deprecation level for empty function
devcrocod Jun 14, 2023
0f8ac27
Update KEMath.kt to include unchecked cast TODO
devcrocod Jun 14, 2023
7437b38
Add ComplexDouble subclasses to DataType conversion
devcrocod Jun 14, 2023
df4f1bb
Add tests for creation one-dimensional arrays with each type
devcrocod Jun 14, 2023
76465a8
Rename and refactor Create2DArrayTests
devcrocod Jun 20, 2023
c2d911e
Add korro plugin in multik-core and update kotlin version
devcrocod Jul 12, 2023
9d3c9f4
Add documentation system for Multik library
devcrocod Jul 12, 2023
6dd0f28
Add overview to documentation
devcrocod Jul 12, 2023
b3b9e1d
Add documentation structure for Multik library
devcrocod Jul 12, 2023
a7ce33b
Add test case files and update `Quickstart` and `Getting Started` in …
devcrocod Jul 18, 2023
6f86e9a
Add 'Kodee-naughty' SVG image to documentation
devcrocod Jul 18, 2023
f77fedf
Update 'Installation' section in Multik library documentation
devcrocod Jul 18, 2023
cbd8862
Update 'overview' and 'supported-platforms' documentation files for M…
devcrocod Jul 18, 2023
5acbcd7
Update Multik library documentation
devcrocod Jul 18, 2023
dc30ed6
Refactor test cases in create2DArray.kt
devcrocod Jul 19, 2023
0094cfa
Rename test file and refactor test cases
devcrocod Jul 19, 2023
1ec98e2
Expand 3D array creation in multik-core test
devcrocod Jul 19, 2023
276f115
Refactor createArray4DTest to new file structure
devcrocod Jul 19, 2023
87011ac
Refactor test structure for NDArray creation
devcrocod Jul 19, 2023
4fd4064
Update copyright year and modify test function naming
devcrocod Jul 19, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ val sonatypePassword: String = System.getenv("SONATYPE_PASSWORD") ?: ""

nexusPublishing {
packageGroup.set(project.group.toString())
repositories {
this.repositories {
sonatype {
username.set(sonatypeUser)
password.set(sonatypePassword)
Expand Down
9 changes: 9 additions & 0 deletions docs/c.list
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE categories
SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
<categories>
<category id="ext" name="External resources" order="1"/>
<category id="get-start" name="Getting Started" order="2"/>
<category id="user-guide" name="User Guide" order="3"/>
<category id="api-docs" name="API Documentation" order="4"/>
</categories>
26 changes: 26 additions & 0 deletions docs/cfg/buildprofiles.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<variables>
<enable-browser-edits>true</enable-browser-edits>
<browser-edits-url>https://github.com/multik/docs/edit/master/</browser-edits-url>
<auto-convert-headings-to-chapters>true</auto-convert-headings-to-chapters>
</variables>
<build-profile instance="mdoc">
<variables>
<noindex-content>false</noindex-content>
</variables>
</build-profile>
<footer>
<social type="blog" href="https://blog.jetbrains.com/kotlin/category/data-science/"/>
<social type="twitter" href="https://twitter.com/KotlinForData"/>
<social type="youtube" href="https://www.youtube.com/@Kotlin"/>
<!-- <link href="https://github.com/Kotlin/multik">GitHub</link>-->
<link href="https://github.com/Kotlin/multik">GitHub</link>
<link href="https://kotlinlang.slack.com/archives/C4W52CFEZ">Slack Community</link>
<!--TODO Copyright (JetBrains or Kotlin?)-->
<copyright>2000–2023 JetBrains s.r.o.</copyright>
</footer>

</buildprofiles>
73 changes: 73 additions & 0 deletions docs/images/Kodee_Assets_Digital_Kodee-naughty.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/kotlin_notebook_installation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/overview-architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/overview-architecture_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
141 changes: 141 additions & 0 deletions docs/mdoc.tree
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE instance-profile
SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">

<instance-profile id="mdoc"
name="Multik"
start-page="home.topic" is-library="true" status="eap">

<toc-element toc-title="Home" topic="home.topic"/>
<toc-element topic="overview.md"/>
<toc-element toc-title="Getting-Started" topic="getting-started.topic">
<toc-element topic="quickstart.md"/>
<toc-element topic="installation.md"/>
<toc-element topic="supported-platforms.md"/>
</toc-element>
<toc-element toc-title="User Guide" topic="user-guide.topic">
<toc-element toc-title="About Multik"/>
<toc-element topic="basic.md">
<toc-element topic="creating-multidimensional-arrays.md"/>
<toc-element topic="indexing-and-slicing.md"/>
<toc-element topic="shape-manipulation.md"/>
<toc-element topic="iterating-over-arrays.md"/>
<toc-element topic="type-casting.md"/>
<toc-element topic="copies-and-views.md"/>
<toc-element topic="complex-numbers.md"/>
</toc-element>
<toc-element topic="engines-of-multik.md"/>
<toc-element topic="multik-on-different-platforms.md">
<toc-element toc-title="Multik on JVM" topic="multik-on-JVM.md"/>
<toc-element toc-title="Multik on JavaScript" topic="multik-on-JavaScript.md"/>
<toc-element toc-title="Multik on WASM" topic="multik-on-WASM.md"/>
<toc-element toc-title="Multik on Mobile (Android, iOS)" topic="multik-on-mobile.md"/>
<toc-element toc-title="Multik on Desktop (MacOS, Win, Linux)" topic="multik-on-desktop.md"/>
</toc-element>
<toc-element topic="input-and-output.md"/>
<toc-element topic="performance-and-optimization.md"/>
</toc-element>
<toc-element topic="documentation.md">
<toc-element topic="array-objects.md">
<toc-element topic="NDArray Class.md"/>
<toc-element topic="scalars.md"/>
<toc-element topic="type.md"/>
<toc-element topic="dimension.md"/>
<toc-element topic="indexing-routines.md"/>
<toc-element topic="iterating.md"/>
<toc-element topic="IO-operations.md"/>
</toc-element>
<toc-element topic="constants.md"/>
<toc-element topic="array-creation.md">
<toc-element topic="arange.md"/>
<toc-element topic="d1array.md"/>
<toc-element topic="d3array.md"/>
<toc-element topic="d3arrayIndices.md"/>
<toc-element topic="d4arrayIndices.md"/>
<toc-element topic="d2arrayIndices.md"/>
<toc-element topic="d2array.md"/>
<toc-element topic="d4array.md"/>
<toc-element topic="dnarray.md"/>
<toc-element topic="identity.md"/>
<toc-element topic="linspace.md"/>
<toc-element topic="meshgrid.md"/>
<toc-element topic="ndarray.md"/>
<toc-element topic="ndarrayOf.md"/>
<toc-element topic="ones.md"/>
<toc-element topic="rand.md"/>
<toc-element topic="toNDArray.md"/>
<toc-element topic="zeros.md"/>
</toc-element>
<toc-element topic="random-number-generation.md"/>
<toc-element topic="array-operations.md">
<toc-element topic="arithmetic-operations.md"/>
<toc-element topic="logical-operations.md"/>
<toc-element topic="comparison-operations.md"/>
<toc-element topic="universal-operations.md">
<toc-element topic="all.md"/>
<toc-element topic="any.md"/>
<toc-element topic="asSequence.md"/>
<toc-element topic="associate.md"/>
<toc-element topic="average.md"/>
<toc-element topic="chunked.md"/>
<toc-element topic="contains.md"/>
<toc-element topic="count.md"/>
<toc-element topic="distinct.md"/>
<toc-element topic="distinct.md"/>
<toc-element topic="drop.md"/>
<toc-element topic="drop.md"/>
<toc-element topic="filter.md"/>
<toc-element topic="find.md"/>
<toc-element topic="first.md"/>
<toc-element topic="flatMap.md"/>
<toc-element topic="fold.md"/>
<toc-element topic="forEach.md"/>
<toc-element topic="groupNDArray.md"/>
<toc-element topic="indexOf.md"/>
<toc-element topic="intersect.md"/>
<toc-element topic="joinTo.md"/>
<toc-element topic="last.md"/>
<toc-element topic="map.md"/>
<toc-element topic="minimum.md"/>
<toc-element topic="maximum.md"/>
<toc-element topic="max.md"/>
<toc-element topic="min.md"/>
<toc-element topic="onEach.md"/>
<toc-element topic="partition.md"/>
<toc-element topic="windowed.md"/>
<toc-element topic="reduce.md"/>
<toc-element topic="reversed.md"/>
<toc-element topic="scan.md"/>
<toc-element topic="sorted.md"/>
<toc-element topic="sum.md"/>
<toc-element topic="toList.md"/>
<toc-element topic="toPrimitiveArray.md"/>
<toc-element topic="toArray.md"/>
<toc-element topic="toCollection.md"/>
<toc-element topic="toType.md"/>
</toc-element>
</toc-element>
<toc-element topic="mathematical.md"/>
<toc-element topic="linear-algebra.md">
<toc-element topic="dot.md"/>
<toc-element topic="matrix-operations.md"/>
<toc-element topic="eigenvalues-and-eigenvectors.md"/>
<toc-element topic="solving-systems-of-equations.md"/>
<toc-element topic="matrix-norms.md"/>
</toc-element>
<toc-element topic="statistics.md">
<toc-element topic="descriptive-statistics.md"/>
<toc-element topic="correlation-analysis.md"/>
<toc-element topic="hypothesis-testing.md"/>
<toc-element topic="probability-distributions.md"/>
</toc-element>
<toc-element href="https://kotlin.github.io/multik/" toc-title="API-Reference"/>
</toc-element>
<toc-element topic="examples.md"/>
<toc-element topic="FAQ.md"/>
<toc-element topic="additional-resources-and-links.md">
<toc-element topic="project-repository.md"/>
<toc-element topic="community-and-contribution-guidelines.md"/>
<toc-element topic="release-notes-and-updates.md"/>
</toc-element>
</instance-profile>
13 changes: 13 additions & 0 deletions docs/project.ihp
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">

<ihp version="2.0">
<topics dir="topics"/>
<images dir="images"/>
<categories src="c.list"/>
<instance src="mdoc.tree" web-path="/mdoc/" version="0.3.0"/>
<settings>
<default-property element-name="chapter" property-name="show-structure-depth" value="2"/>
<default-property element-name="toc-element" property-name="show-structure-depth" value="2"/>
</settings>
</ihp>
6 changes: 6 additions & 0 deletions docs/topics/FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# FAQ

[//]: # (TODO)
<web-summary>TODO</web-summary>
<card-summary>TODO</card-summary>
<link-summary>TODO</link-summary>
6 changes: 6 additions & 0 deletions docs/topics/additional-resources-and-links.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Additional Resources and Links

[//]: # (TODO)
<web-summary>TODO</web-summary>
<card-summary>TODO</card-summary>
<link-summary>TODO</link-summary>
6 changes: 6 additions & 0 deletions docs/topics/apiDocs/IO-operations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# IO operations

[//]: # (TODO)
<web-summary>TODO</web-summary>
<card-summary>TODO</card-summary>
<link-summary>TODO</link-summary>
6 changes: 6 additions & 0 deletions docs/topics/apiDocs/NDArray Class.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# NDArray

[//]: # (TODO)
<web-summary>TODO</web-summary>
<card-summary>TODO</card-summary>
<link-summary>TODO</link-summary>
3 changes: 3 additions & 0 deletions docs/topics/apiDocs/NDArray.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# ndarray

Start typing here...
3 changes: 3 additions & 0 deletions docs/topics/apiDocs/all.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# all

Start typing here...
3 changes: 3 additions & 0 deletions docs/topics/apiDocs/any.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# any

Start typing here...
3 changes: 3 additions & 0 deletions docs/topics/apiDocs/arange.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# arange

Start typing here...
6 changes: 6 additions & 0 deletions docs/topics/apiDocs/arithmetic-operations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Arithmetic Operations

[//]: # (TODO)
<web-summary>TODO</web-summary>
<card-summary>TODO</card-summary>
<link-summary>TODO</link-summary>
6 changes: 6 additions & 0 deletions docs/topics/apiDocs/array-creation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Array creation

[//]: # (TODO)
<web-summary>TODO</web-summary>
<card-summary>TODO</card-summary>
<link-summary>TODO</link-summary>
6 changes: 6 additions & 0 deletions docs/topics/apiDocs/array-objects.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Array objects

[//]: # (TODO)
<web-summary>TODO</web-summary>
<card-summary>TODO</card-summary>
<link-summary>TODO</link-summary>
6 changes: 6 additions & 0 deletions docs/topics/apiDocs/array-operations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Array Operations

[//]: # (TODO)
<web-summary>TODO</web-summary>
<card-summary>TODO</card-summary>
<link-summary>TODO</link-summary>
3 changes: 3 additions & 0 deletions docs/topics/apiDocs/asSequence.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# asSequence

Start typing here...
3 changes: 3 additions & 0 deletions docs/topics/apiDocs/associate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# associate

Start typing here...
3 changes: 3 additions & 0 deletions docs/topics/apiDocs/average.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# average

Start typing here...
3 changes: 3 additions & 0 deletions docs/topics/apiDocs/chunked.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# chunked

Start typing here...
6 changes: 6 additions & 0 deletions docs/topics/apiDocs/comparison-operations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Comparison Operations

[//]: # (TODO)
<web-summary>TODO</web-summary>
<card-summary>TODO</card-summary>
<link-summary>TODO</link-summary>
6 changes: 6 additions & 0 deletions docs/topics/apiDocs/constants.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Constants

[//]: # (TODO)
<web-summary>TODO</web-summary>
<card-summary>TODO</card-summary>
<link-summary>TODO</link-summary>
Loading