Skip to content
This repository was archived by the owner on Jan 20, 2023. It is now read-only.

Commit e1bec16

Browse files
k163377k163377
authored
Merge pull request #2 from k163377/add_readme
Add readme.
2 parents e25b715 + 9a57110 commit e1bec16

File tree

5 files changed

+294
-6
lines changed

5 files changed

+294
-6
lines changed

‎LICENSE

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
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+
Copyright 2020 wrongwrong(https://github.com/k163377)
179+
180+
Licensed under the Apache License, Version 2.0 (the "License");
181+
you may not use this file except in compliance with the License.
182+
You may obtain a copy of the License at
183+
184+
http://www.apache.org/licenses/LICENSE-2.0
185+
186+
Unless required by applicable law or agreed to in writing, software
187+
distributed under the License is distributed on an "AS IS" BASIS,
188+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189+
See the License for the specific language governing permissions and
190+
limitations under the License.

‎README.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,102 @@
1+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
2+
![Lint, Test, and upload Coveradge with Gradle.](https://github.com/ProjectMapK/FastKFunction/workflows/Lint,%20Test,%20and%20upload%20Coveradge%20with%20Gradle./badge.svg)
3+
[![codecov](https://codecov.io/gh/ProjectMapK/FastKFunction/branch/master/graph/badge.svg?token=LcZTfSL7c8)](https://codecov.io/gh/ProjectMapK/FastKFunction)
4+
5+
---
6+
17
FastKFunction
8+
===
9+
`FastKFunction` is a wrapper library for fast calls to `KFunction`.
10+
11+
## Demo code
12+
With just this description, you can call the `KFunction` faster.
13+
14+
```kotlin
15+
data class Sample(
16+
val arg1: Int,
17+
val arg2: Int,
18+
val arg3: Int,
19+
val arg4: Int,
20+
val arg5: Int
21+
)
22+
23+
val function: KFunction<Sample> = ::Sample
24+
25+
val fastKFunction: FastKFunction<Sample> = FastKFunction(function)
26+
27+
// call by vararg
28+
val result: Sample = fastKFunction.call(1, 2, 3, 4, 5)
29+
30+
// call by Collection
31+
val result: Sample = fastKFunction.callByCollection(listOf(1, 2, 3, 4, 5))
32+
33+
// call by ArgumentBucket
34+
val result: Sample = fastKFunction.generateBucket()
35+
.apply { (0 until 5).forEach { this[it] = it + 1 }}
36+
.let { fastKFunction.callBy(it) }
37+
```
38+
39+
## Installation
40+
TODO
41+
42+
## How to use FastKFunction.
43+
44+
### Instance parameter.
45+
If you call an instance function, you can expect a faster call with `instance parameter`.
46+
47+
```kotlin
48+
data class Sample(
49+
val arg1: Int,
50+
val arg2: Int
51+
) {
52+
fun instanceFun(arg3: Int): Int = arg1 + arg2 + arg3
53+
}
54+
55+
val sample = Sample(1, 2)
56+
57+
val fastKFunction = FastKFunction(sample::instanceFun, sample)
58+
```
59+
60+
Depending on how you get the `KFunction`, the `instance parameter` may be required.
61+
Even if the `instance parameter` is not required, passing an `instance parameter` will make the call faster.
62+
63+
### How to call.
64+
`FastKFunction` supports two major types of calls.
65+
66+
#### Call by vararg or Collection.
67+
Calling with `vararg` or `Collection` is faster if you don't need to use the default arguments and
68+
can get them in the order in which they are defined.
69+
70+
```kotlin
71+
val fastKFunction: FastKFunction<Sample> = FastKFunction(function)
72+
73+
// call by vararg
74+
val result: Sample = fastKFunction.call(1, 2, 3, 4, 5)
75+
76+
// call by Collection
77+
val result: Sample = fastKFunction.callByCollection(listOf(1, 2, 3, 4, 5))
78+
```
79+
80+
#### Call by ArgumentBucket.
81+
If the default argument is expected to be used, a call using `ArgumentBucket` is available.
82+
83+
`ArgumentBucket` has interfaces like `MutableMap<KParameter, Any?>`, which can be used, for example, as follows.
84+
85+
```kotlin
86+
data class Sample(
87+
val arg1: Int,
88+
val arg2: Int = 0,
89+
val arg3: String? = null
90+
)
91+
92+
private val fastKFunction: FastKFunction<Sample> = FastKFunction(::Sample)
93+
94+
fun map(src: Map<String, Any?>): Sample {
95+
return fastKFunction.generateBucket()
96+
.apply {
97+
fastKFunction.valueParameters.forEach {
98+
if (src.containsKey(it.name!!)) this[it] = src.getValue(it.name!!)
99+
}
100+
}.let { fastKFunction.callBy(it) }
101+
}
102+
```

‎src/main/kotlin/com/mapk/fastkfunction/FastKFunction.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import kotlin.reflect.jvm.isAccessible
1212
import kotlin.reflect.jvm.javaConstructor
1313
import kotlin.reflect.jvm.javaMethod
1414

15-
class FastKFunction<T>(private val function: KFunction<T>, instance: Any?) {
15+
class FastKFunction<T>(private val function: KFunction<T>, instance: Any? = null) {
1616
val valueParameters: List<KParameter> // 公開するのはバインドに使うパラメータのみ
1717
private val fullInitializedFunction: (Array<out Any?>) -> T
1818
private val bucketGenerator: BucketGenerator

‎src/test/kotlin/com/mapk/fastkfunction/argumentBucket/ArgumentBucketTest.kt renamed to ‎src/test/kotlin/com/mapk/fastkfunction/argumentbucket/ArgumentBucketTest.kt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
package com.mapk.fastkfunction.argumentBucket
1+
package com.mapk.fastkfunction.argumentbucket
22

3-
import com.mapk.fastkfunction.argumentbucket.ArgumentBucket
4-
import com.mapk.fastkfunction.argumentbucket.BucketGenerator
53
import org.junit.jupiter.api.Assertions.assertEquals
64
import org.junit.jupiter.api.Assertions.assertNull
75
import org.junit.jupiter.api.Assertions.assertTrue

‎src/test/kotlin/com/mapk/fastkfunction/argumentBucket/BucketGeneratorTest.kt renamed to ‎src/test/kotlin/com/mapk/fastkfunction/argumentbucket/BucketGeneratorTest.kt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
package com.mapk.fastkfunction.argumentBucket
1+
package com.mapk.fastkfunction.argumentbucket
22

3-
import com.mapk.fastkfunction.argumentbucket.BucketGenerator
43
import org.junit.jupiter.api.Assertions.assertArrayEquals
54
import org.junit.jupiter.api.Nested
65
import org.junit.jupiter.api.Test

0 commit comments

Comments
 (0)