[jira] [Commented] (NUMBERS-70) Userguide and reports

2022-10-19 Thread Alex Herbert (Jira)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17620590#comment-17620590
 ] 

Alex Herbert commented on NUMBERS-70:
-

Initial user guide added in commit:

07443607d94fa3caf17dba8e9396c3907115c178

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles Sadowski
>Priority: Minor
>  Labels: benchmark, documentation
> Attachments: 0001-Angles-xdoc-is-added.patch, 
> 0001-Prime-xdoc-file-is-added.patch, 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian Jira
(v8.20.10#820010)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2020-02-25 Thread Gilles Sadowski (Jira)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17044907#comment-17044907
 ] 

Gilles Sadowski commented on NUMBERS-70:


See answer above.

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles Sadowski
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2020
> Attachments: 0001-Angles-xdoc-is-added.patch, 
> 0001-Prime-xdoc-file-is-added.patch, 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian Jira
(v8.3.4#803005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2020-02-25 Thread kodjo Tchakoute Constantin leroy (Jira)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17044646#comment-17044646
 ] 

kodjo Tchakoute Constantin leroy commented on NUMBERS-70:
-

Hello pls how can i do to join this Organisation ??

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles Sadowski
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2020
> Attachments: 0001-Angles-xdoc-is-added.patch, 
> 0001-Prime-xdoc-file-is-added.patch, 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian Jira
(v8.3.4#803005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2020-02-11 Thread Gilles Sadowski (Jira)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17034783#comment-17034783
 ] 

Gilles Sadowski commented on NUMBERS-70:


I suggest that you post on the "dev" mailing list (you have to 
[subscribe|http://commons.apache.org/mail-lists.html]).
 There is a [discussion thread|https://markmail.org/message/m76fqra53ijev2mx] 
about such initiatives, but not much participation from the project developers 
up to now...

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles Sadowski
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2020
> Attachments: 0001-Angles-xdoc-is-added.patch, 
> 0001-Prime-xdoc-file-is-added.patch, 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian Jira
(v8.3.4#803005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2020-02-02 Thread Kaaira Gupta (Jira)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17028479#comment-17028479
 ] 

Kaaira Gupta commented on NUMBERS-70:
-

Hey [~erans] !! Is this up for Outreachy summers 2020 as well?

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles Sadowski
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2020
> Attachments: 0001-Angles-xdoc-is-added.patch, 
> 0001-Prime-xdoc-file-is-added.patch, 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian Jira
(v8.3.4#803005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-04-04 Thread Gilles (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16809783#comment-16809783
 ] 

Gilles commented on NUMBERS-70:
---

{quote}what else i can do
{quote}
It's really up to you, depending on your interests (?) and programming skills 
(?).
 E.g. if you are math-oriented, the projects to look at are indeed:
 * "Commons Numbers",
 * "Commons Statistics",
 * "Commons RNG",
 * "Commons Geometry",
 * "Commons Math".

You are most welcome to select and fix any of the bugs filed in their 
respective bug-tracking systems (see link on the specific project's web site). 
If not done already, you should read [how to 
contribute|http://commons.apache.org/proper/commons-numbers/developers.html].

There are several other projects in ["Commons"|http://commons.apache.org/] and 
some may be more interesting or more accessible.

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
> Attachments: 0001-Angles-xdoc-is-added.patch, 
> 0001-Prime-xdoc-file-is-added.patch, 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-04-03 Thread Abhishek Chaudhary (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16809105#comment-16809105
 ] 

Abhishek Chaudhary commented on NUMBERS-70:
---

So, what else i can do or how to contribute further in continuation of this 
process ?

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
> Attachments: 0001-Angles-xdoc-is-added.patch, 
> 0001-Prime-xdoc-file-is-added.patch, 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-04-03 Thread Alex D Herbert (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16808822#comment-16808822
 ] 

Alex D Herbert commented on NUMBERS-70:
---

To convert an angle in radians to degrees you can skip this library altogether 
and use the method that has been in java since 1.2:
{code:java}
final double angleDeg = 180;
final double angleRad = Math.toRadians(angleDeg);
{code}
The {{PlaneAngle}} class encapsulates the idea that an angle is a number of 
turns around a circle and provides for creation from different units, 
normalisation (+/- 0.5 turns) from a reference number of turns and equality 
comparisons. A contrived example would be:
{code:java}
final PlaneAngle half = PlaneAngle.ofRadians(Math.PI);
final PlaneAngle threeQuarters = PlaneAngle.ofDegrees(270);

// 1.25 turns
final PlaneAngle halfPlusThreeQuarters = 
PlaneAngle.ofTurns(half.toTurns() + threeQuarters.toTurns());

assert halfPlusThreeQuarters.equals(PlaneAngle.ofTurns(1.25));

// Normalise to +/- 0.5 of 0.5 is 0.25 turns
assert halfPlusThreeQuarters.normalize(half).equals(PlaneAngle.ofTurns(0.25));
{code}

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
> Attachments: 0001-Angles-xdoc-is-added.patch, 
> 0001-Prime-xdoc-file-is-added.patch, 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-04-03 Thread Gilles (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16808775#comment-16808775
 ] 

Gilles commented on NUMBERS-70:
---

{code:java}
import org.apache.commons.numbers.angle.PlaneAngle
import org.apache.commons.numbers.angle.PlaneAngleRadians

public double To_Angle{
private static final double to_radians = 2 * Math.PI;
public double Radians(double value) {
return value * to_radians;
}
}
{code}
Did you compile the above code?

Documentation should certainly not show examples that contradict conventions 
used by the project (Java programmers are used to the "Camel case" syntax with 
identifiers starting with a lowercase letter).

Again, you seem to show an alternative implementation of a functionality which 
the library readily provides; if a user would want to convert an angle given in 
degrees to its value in radians, here is the code he'd use:
{code:java}
import org.apache.commons.numbers.angle.PlaneAngle;

final double angleDeg = 180;
final double angleRad = PlaneAngle.ofDegrees(angleDeg).toRadians();
{code}
Even so, the purpose your code is not obvious (as it misses comment and/or 
Javadoc): You don't specify what it is that we convert from (turns (?)).

{quote}How can i share my proposal with you ?
{quote}
Do you mean a GSoC proposal?
 If so, we are not yet at that point: Contributing documentation cannot require 
someone to correct almost every line you write; in the latest patch, I count 
largely more than 10 errors (English syntax and spelling, xdoc syntax, Java 
code syntax and formatting).

If you'd like to contribute, I'd suggest that you try something else, more 
"coding-oriented".

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
> Attachments: 0001-Angles-xdoc-is-added.patch, 
> 0001-Prime-xdoc-file-is-added.patch, 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-04-02 Thread Abhishek Chaudhary (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16807839#comment-16807839
 ] 

Abhishek Chaudhary commented on NUMBERS-70:
---

Those link given by you were useful, I got an idea how to make usage and index 
for common-numbers.

How can i share my proposal with you ?

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
> Attachments: 0001-Angles-xdoc-is-added.patch, 
> 0001-Prime-xdoc-file-is-added.patch, 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-04-02 Thread Abhishek Chaudhary (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16807838#comment-16807838
 ] 

Abhishek Chaudhary commented on NUMBERS-70:
---

[^0001-Angles-xdoc-is-added.patch]

Example and information about angles is added.

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
> Attachments: 0001-Angles-xdoc-is-added.patch, 
> 0001-Prime-xdoc-file-is-added.patch, 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-04-01 Thread Gilles (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16807207#comment-16807207
 ] 

Gilles commented on NUMBERS-70:
---

[http://commons.apache.org/proper/commons-rng/modules.html]
[http://commons.apache.org/proper/commons-rng/userguide/index.html]
[http://commons.apache.org/proper/commons-math/userguide/index.html]

bq. I am confused at this stage.

So am I.


> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
> Attachments: 0001-Prime-xdoc-file-is-added.patch, 
> 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-04-01 Thread Abhishek Chaudhary (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16807013#comment-16807013
 ] 

Abhishek Chaudhary commented on NUMBERS-70:
---

I am confused at this stage. Previously when i described a method for prime 
numbers you suggest that we should describe something that is existing in 
library .

Can you give some specific examples, like i should write documentation ?

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
> Attachments: 0001-Prime-xdoc-file-is-added.patch, 
> 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-04-01 Thread Gilles (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16806892#comment-16806892
 ] 

Gilles commented on NUMBERS-70:
---

{quote}
{code}
  public static boolean isPrime(int n) {
  if (n < 2) {
  return false;
  }

  for (int p : SmallPrimes.PRIMES) {
  if (0 == (n % p)) {
  return n == p;
  }
  }
  return SmallPrimes.millerRabinPrimeTest(n);
  }
{code}
{quote}

At this level, documentation is for _users_ of the library.
The library provides a method [{{isPrime(int 
n)}}|https://commons.apache.org/proper/commons-numbers/commons-numbers-primes/apidocs/org/apache/commons/numbers/primes/Primes.html#isPrime-int-]
 in class {{Primes}}; hence, why show an alternative implementation?
Moreover {{SmallPrimes}} is not public.


> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
> Attachments: 0001-Prime-xdoc-file-is-added.patch, 
> 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-04-01 Thread Abhishek Chaudhary (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16806851#comment-16806851
 ] 

Abhishek Chaudhary commented on NUMBERS-70:
---

[^0001-Prime-xdoc-file-is-added.patch]

Modified as per your suggestions.

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
> Attachments: 0001-Prime-xdoc-file-is-added.patch, 
> 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-03-31 Thread Gilles (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16806291#comment-16806291
 ] 

Gilles commented on NUMBERS-70:
---

bq. Is there any specific format of proposal ?

https://community.apache.org/gsoc.html

bq. patch is \[...\] summary of primary numbers and the code for its 
implementation.

There seems to be some misunderstanding about what you are supposed to achieve.
Documentation is meant to illustrate existing functionality, not presenting 
alternative implementations.
Moreover, ensuring that a code snippet works does not mean that you have to 
include a {{main}} method.


> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
> Attachments: 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-03-31 Thread Abhishek Chaudhary (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16806231#comment-16806231
 ] 

Abhishek Chaudhary commented on NUMBERS-70:
---

Should I start writing a proposal ?

Is there any specific format of proposal ?

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
> Attachments: 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-03-31 Thread Abhishek Chaudhary (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16806229#comment-16806229
 ] 

Abhishek Chaudhary commented on NUMBERS-70:
---

[^0001-Primes-xdoc-is-added.patch]

This patch is about common-numbers-primes usage. About summary of primary 
numbers and the code for its implementation.

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
> Attachments: 0001-Primes-xdoc-is-added.patch
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-03-30 Thread Gilles (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16805858#comment-16805858
 ] 

Gilles commented on NUMBERS-70:
---

A patch file should be *attached* (see the "Attachments" section near the top 
of this page), not posted as a comment.

It's nice that you propose adding documentation, but to be useful for 
application developers, it should contain more than one line...
 The purpose is to document what can be done with the code (i.e. code snippets 
showing _how_ to use the available functionality). As an example, please have a 
look at [that 
file|https://gitbox.apache.org/repos/asf?p=commons-rng.git;a=blob;f=commons-rng-simple/src/site/xdoc/index.xml]
 (for a module of "Commons RNG").
 That implies that you should
 # look at what the library code can do,
 # write a usage example,
 # check that the example works (can be compiled and provides the expected 
result).

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-03-30 Thread Abhishek Chaudhary (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16805784#comment-16805784
 ] 

Abhishek Chaudhary commented on NUMBERS-70:
---

I have sent the patch for common numbers prime. Please check it out.

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-03-30 Thread Abhishek Chaudhary (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16805776#comment-16805776
 ] 

Abhishek Chaudhary commented on NUMBERS-70:
---

[~erans], I had to pull request in master branch ?

Can you tell me where i had to pull a request i.e. branch(link to be cloned) ?

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-03-29 Thread Gilles (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16805494#comment-16805494
 ] 

Gilles commented on NUMBERS-70:
---

bq.  I have written one module

I don't understand the meaning of "module" here.

bq. How can I show you?

Through a patch attached to this issue or a "pull request" (git).

bq. how to contribute ?

You should probably read [this 
page|http://commons.apache.org/proper/commons-numbers/developers.html].

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-03-29 Thread Abhishek Chaudhary (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16805203#comment-16805203
 ] 

Abhishek Chaudhary commented on NUMBERS-70:
---

[~erans] , I have written one module in same way.

How can I show you? or else how to contribute ?

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-03-29 Thread Gilles (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16805003#comment-16805003
 ] 

Gilles commented on NUMBERS-70:
---

You should check out ("git clone") the source reprository:
    https://gitbox.apache.org/repos/asf?p=commons-numbers.git

The modules are subdirectories named "commons-numbers-...".
And the "index.xml" file is under "src/site/xdoc".

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-03-29 Thread Abhishek Chaudhary (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16804985#comment-16804985
 ] 

Abhishek Chaudhary commented on NUMBERS-70:
---

Hello [~erans], can you direct me where the maven modules are there. When I 
looked i got some files which are last updated in 2014 , we need to update the 
xml code for that ?

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-03-28 Thread Gilles (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16804360#comment-16804360
 ] 

Gilles commented on NUMBERS-70:
---

{quote} still open ?
{quote}
Yes.

I'd suggest that the first step is to write a summary of usage in the "index" 
files like [this 
one|https://gitbox.apache.org/repos/asf?p=commons-numbers.git;a=blob_plain;f=commons-numbers-angle/src/site/xdoc/index.xml;hb=HEAD]
 (one per maven module).

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2019-03-28 Thread Abhishek Chaudhary (JIRA)


[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16804318#comment-16804318
 ] 

Abhishek Chaudhary commented on NUMBERS-70:
---

Hello [~erans],

I would like to pick this issue if its still open ?

Can you guide me from where to start ?

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2018-03-23 Thread Akhil Seshan (JIRA)

[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16411398#comment-16411398
 ] 

Akhil Seshan commented on NUMBERS-70:
-

I sent the subscription mail to that address but there is no response till now. 
so i haven't subscribed to the mailing list.

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2018
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).
> Current content of 
> [src/site/xdoc/userguide|https://git1-us-west.apache.org/repos/asf?p=commons-numbers.git;a=tree;f=src/site/xdoc/userguide;h=49c015a4186f3edfb596dcdc5bd53a257959c59c;hb=HEAD]
>  is still a copy from CM.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2018-03-23 Thread Gilles (JIRA)

[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16411342#comment-16411342
 ] 

Gilles commented on NUMBERS-70:
---

bq. should i submit the proposal now?

As you wish. ;)
It does need to be formal; just state your interest in that forum where general 
discussions should take place.
Then, you might test what you want to propose on a small part of the code in 
order to showcase what you intend to deliver.

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2018
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).
> Current content of 
> [src/site/xdoc/userguide|https://git1-us-west.apache.org/repos/asf?p=commons-numbers.git;a=tree;f=src/site/xdoc/userguide;h=49c015a4186f3edfb596dcdc5bd53a257959c59c;hb=HEAD]
>  is still a copy from CM.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2018-03-23 Thread Akhil Seshan (JIRA)

[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16411330#comment-16411330
 ] 

Akhil Seshan commented on NUMBERS-70:
-

is there any particular template for creating the proposal?

 

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2018
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).
> Current content of 
> [src/site/xdoc/userguide|https://git1-us-west.apache.org/repos/asf?p=commons-numbers.git;a=tree;f=src/site/xdoc/userguide;h=49c015a4186f3edfb596dcdc5bd53a257959c59c;hb=HEAD]
>  is still a copy from CM.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2018-03-23 Thread Akhil Seshan (JIRA)

[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16411318#comment-16411318
 ] 

Akhil Seshan commented on NUMBERS-70:
-

should i submit the proposal?

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2018
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).
> Current content of 
> [src/site/xdoc/userguide|https://git1-us-west.apache.org/repos/asf?p=commons-numbers.git;a=tree;f=src/site/xdoc/userguide;h=49c015a4186f3edfb596dcdc5bd53a257959c59c;hb=HEAD]
>  is still a copy from CM.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2018-03-23 Thread Gilles (JIRA)

[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16411298#comment-16411298
 ] 

Gilles commented on NUMBERS-70:
---

http://commons.apache.org/mail-lists.html

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2018
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).
> Current content of 
> [src/site/xdoc/userguide|https://git1-us-west.apache.org/repos/asf?p=commons-numbers.git;a=tree;f=src/site/xdoc/userguide;h=49c015a4186f3edfb596dcdc5bd53a257959c59c;hb=HEAD]
>  is still a copy from CM.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2018-03-23 Thread Akhil Seshan (JIRA)

[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16411281#comment-16411281
 ] 

Akhil Seshan commented on NUMBERS-70:
-

can you provide me the link to subscribe to dev mailing list

 

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2018
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).
> Current content of 
> [src/site/xdoc/userguide|https://git1-us-west.apache.org/repos/asf?p=commons-numbers.git;a=tree;f=src/site/xdoc/userguide;h=49c015a4186f3edfb596dcdc5bd53a257959c59c;hb=HEAD]
>  is still a copy from CM.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2018-03-23 Thread Gilles (JIRA)

[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16411268#comment-16411268
 ] 

Gilles commented on NUMBERS-70:
---

No problem as far I can tell, but you should post a message on the "dev" 
mailing list.  Thanks for your interest!

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2018
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).
> Current content of 
> [src/site/xdoc/userguide|https://git1-us-west.apache.org/repos/asf?p=commons-numbers.git;a=tree;f=src/site/xdoc/userguide;h=49c015a4186f3edfb596dcdc5bd53a257959c59c;hb=HEAD]
>  is still a copy from CM.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)


[jira] [Commented] (NUMBERS-70) Userguide and reports

2018-03-23 Thread Akhil Seshan (JIRA)

[ 
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16411229#comment-16411229
 ] 

Akhil Seshan commented on NUMBERS-70:
-

Can I do this as a GSoC 2018 project?

> Userguide and reports
> -
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
>  Issue Type: Wish
>Reporter: Gilles
>Priority: Minor
>  Labels: benchmark, documentation, gsoc2018
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide 
> and write benchmarking code for generating performance reports 
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).
> Current content of 
> [src/site/xdoc/userguide|https://git1-us-west.apache.org/repos/asf?p=commons-numbers.git;a=tree;f=src/site/xdoc/userguide;h=49c015a4186f3edfb596dcdc5bd53a257959c59c;hb=HEAD]
>  is still a copy from CM.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)