Re: svn commit: r1042610 - /commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java

2010-12-06 Thread sebb
On 6 December 2010 12:52,   wrote:
> Author: erans
> Date: Mon Dec  6 12:52:36 2010
> New Revision: 1042610
>
> URL: http://svn.apache.org/viewvc?rev=1042610&view=rev
> Log:
> MATH-453
> Removed Javadoc comment referring to non-existent package.
>
> Modified:
>    
> commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java
>
> Modified: 
> commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java
> URL: 
> http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java?rev=1042610&r1=1042609&r2=1042610&view=diff
> ==
> --- 
> commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java
>  (original)
> +++ 
> commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java
>  Mon Dec  6 12:52:36 2010
> @@ -250,10 +250,7 @@ public interface RealVector {
>      *
>      * @param d Operator value.
>      * @return a mapped copy of the vector.
> -     * @deprecated in 2.2 (to be removed in 3.0). Please use
> -     * {...@link #map(UnivariateRealFunction)} directly with
> -     * the function classes in package
> -     * {...@link org.apache.commons.math.analysis.function}.
> +     * @deprecated in 2.2 (to be removed in 3.0).

Why not leave the reference to #map(UnivariateRealFunction) ?

If something is deprecated, ISTM that the the Javadoc should say what
to use instead.

-
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org



Re: svn commit: r1042610 - /commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java

2010-12-06 Thread Gilles Sadowski
> > @@ -250,10 +250,7 @@ public interface RealVector {
> >      *
> >      * @param d Operator value.
> >      * @return a mapped copy of the vector.
> > -     * @deprecated in 2.2 (to be removed in 3.0). Please use
> > -     * {...@link #map(UnivariateRealFunction)} directly with
> > -     * the function classes in package
> > -     * {...@link org.apache.commons.math.analysis.function}.
> > +     * @deprecated in 2.2 (to be removed in 3.0).
> 
> Why not leave the reference to #map(UnivariateRealFunction) ?

Because the package "function" does not exist in MATH_2_X.

> [...]

Gilles

-
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org



Re: svn commit: r1042610 - /commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java

2010-12-06 Thread sebb
On 6 December 2010 17:17, Gilles Sadowski  wrote:
>> > @@ -250,10 +250,7 @@ public interface RealVector {
>> >      *
>> >      * @param d Operator value.
>> >      * @return a mapped copy of the vector.
>> > -     * @deprecated in 2.2 (to be removed in 3.0). Please use
>> > -     * {...@link #map(UnivariateRealFunction)} directly with
>> > -     * the function classes in package
>> > -     * {...@link org.apache.commons.math.analysis.function}.
>> > +     * @deprecated in 2.2 (to be removed in 3.0).
>>
>> Why not leave the reference to #map(UnivariateRealFunction) ?
>
> Because the package "function" does not exist in MATH_2_X.

I know that, but #map(UnivariateRealFunction) does exist (in the same
source file).

It was only the reference to the package name that was wrong.

If the replacement for the deprecated methods is not
#map(UnivariateRealFunction), then whatever is the replacement should
be specified in the Javadoc.

>> [...]
>
> Gilles
>
> -
> To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
> For additional commands, e-mail: dev-h...@commons.apache.org
>
>

-
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org



Re: svn commit: r1042610 - /commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java

2010-12-06 Thread Gilles Sadowski
> >> > -     * @deprecated in 2.2 (to be removed in 3.0). Please use
> >> > -     * {...@link #map(UnivariateRealFunction)} directly with
> >> > -     * the function classes in package
> >> > -     * {...@link org.apache.commons.math.analysis.function}.
> >> > +     * @deprecated in 2.2 (to be removed in 3.0).
> >>
> >> Why not leave the reference to #map(UnivariateRealFunction) ?
> >
> > Because the package "function" does not exist in MATH_2_X.
> 
> I know that, but #map(UnivariateRealFunction) does exist (in the same
> source file).
> 
> It was only the reference to the package name that was wrong.
> 
> If the replacement for the deprecated methods is not
> #map(UnivariateRealFunction), then whatever is the replacement should
> be specified in the Javadoc.

The replacement is the method "map" (which exists) together with the
appropriate function (which doesn't, unless someone wants to backport the
"function" package).

I think that we agreed with Phil that when the replacement doesn't exist, it
is sufficient to warn the users with a terse deprecation message.


Regards,
Gilles

-
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org



Re: svn commit: r1042610 - /commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java

2010-12-06 Thread sebb
On 6 December 2010 22:21, Gilles Sadowski  wrote:
>> >> > -     * @deprecated in 2.2 (to be removed in 3.0). Please use
>> >> > -     * {...@link #map(UnivariateRealFunction)} directly with
>> >> > -     * the function classes in package
>> >> > -     * {...@link org.apache.commons.math.analysis.function}.
>> >> > +     * @deprecated in 2.2 (to be removed in 3.0).
>> >>
>> >> Why not leave the reference to #map(UnivariateRealFunction) ?
>> >
>> > Because the package "function" does not exist in MATH_2_X.
>>
>> I know that, but #map(UnivariateRealFunction) does exist (in the same
>> source file).
>>
>> It was only the reference to the package name that was wrong.
>>
>> If the replacement for the deprecated methods is not
>> #map(UnivariateRealFunction), then whatever is the replacement should
>> be specified in the Javadoc.
>
> The replacement is the method "map" (which exists) together with the
> appropriate function (which doesn't, unless someone wants to backport the
> "function" package).

There are several implementations of UnivariateRealFunction, e.g.
PolynomialFunctionLagrangeForm.

Are these not suitable as parameters to the map method?

> I think that we agreed with Phil that when the replacement doesn't exist, it
> is sufficient to warn the users with a terse deprecation message.

I don't think it is right to leave the user totally in the dark as to
how to resolve the deprecation warnings.

>
> Regards,
> Gilles
>
> -
> To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
> For additional commands, e-mail: dev-h...@commons.apache.org
>
>

-
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org



Re: svn commit: r1042610 - /commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java

2010-12-07 Thread Gilles Sadowski
Hi.

> On 6 December 2010 22:21, Gilles Sadowski  
> wrote:
> >> >> > -     * @deprecated in 2.2 (to be removed in 3.0). Please use
> >> >> > -     * {...@link #map(UnivariateRealFunction)} directly with
> >> >> > -     * the function classes in package
> >> >> > -     * {...@link org.apache.commons.math.analysis.function}.
> >> >> > +     * @deprecated in 2.2 (to be removed in 3.0).
> >> >>
> >> >> Why not leave the reference to #map(UnivariateRealFunction) ?
> >> >
> >> > Because the package "function" does not exist in MATH_2_X.
> >>
> >> I know that, but #map(UnivariateRealFunction) does exist (in the same
> >> source file).
> >>
> >> It was only the reference to the package name that was wrong.
> >>
> >> If the replacement for the deprecated methods is not
> >> #map(UnivariateRealFunction), then whatever is the replacement should
> >> be specified in the Javadoc.
> >
> > The replacement is the method "map" (which exists) together with the
> > appropriate function (which doesn't, unless someone wants to backport the
> > "function" package).
> 
> There are several implementations of UnivariateRealFunction, e.g.
> PolynomialFunctionLagrangeForm.
> 
> Are these not suitable as parameters to the map method?

They are, but they do not provide a replacement for the deprecated methods,
which is the point of a more detailed deprecation message.

> > I think that we agreed with Phil that when the replacement doesn't exist, it
> > is sufficient to warn the users with a terse deprecation message.
> 
> I don't think it is right to leave the user totally in the dark as to
> how to resolve the deprecation warnings.

There is no possible resolution in 2.2. The deprecation warning says: "You
will have to modify that code when upgrading to 3.0".


Regards,
Gilles

-
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org



Re: svn commit: r1042610 - /commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java

2010-12-07 Thread sebb
On 7 December 2010 09:18, Gilles Sadowski  wrote:
> Hi.
>
>> On 6 December 2010 22:21, Gilles Sadowski  
>> wrote:
>> >> >> > -     * @deprecated in 2.2 (to be removed in 3.0). Please use
>> >> >> > -     * {...@link #map(UnivariateRealFunction)} directly with
>> >> >> > -     * the function classes in package
>> >> >> > -     * {...@link org.apache.commons.math.analysis.function}.
>> >> >> > +     * @deprecated in 2.2 (to be removed in 3.0).
>> >> >>
>> >> >> Why not leave the reference to #map(UnivariateRealFunction) ?
>> >> >
>> >> > Because the package "function" does not exist in MATH_2_X.
>> >>
>> >> I know that, but #map(UnivariateRealFunction) does exist (in the same
>> >> source file).
>> >>
>> >> It was only the reference to the package name that was wrong.
>> >>
>> >> If the replacement for the deprecated methods is not
>> >> #map(UnivariateRealFunction), then whatever is the replacement should
>> >> be specified in the Javadoc.
>> >
>> > The replacement is the method "map" (which exists) together with the
>> > appropriate function (which doesn't, unless someone wants to backport the
>> > "function" package).
>>
>> There are several implementations of UnivariateRealFunction, e.g.
>> PolynomialFunctionLagrangeForm.
>>
>> Are these not suitable as parameters to the map method?
>
> They are, but they do not provide a replacement for the deprecated methods,
> which is the point of a more detailed deprecation message.
>
>> > I think that we agreed with Phil that when the replacement doesn't exist, 
>> > it
>> > is sufficient to warn the users with a terse deprecation message.
>>
>> I don't think it is right to leave the user totally in the dark as to
>> how to resolve the deprecation warnings.
>
> There is no possible resolution in 2.2. The deprecation warning says: "You
> will have to modify that code when upgrading to 3.0".

In which case the upgrade path should be mentioned elsewhere in the
release documentation.

But if we already know what the methods are in 3.0, why not add a note
to the class Javadoc to give the user the information they need?

>
> Regards,
> Gilles
>
> -
> To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
> For additional commands, e-mail: dev-h...@commons.apache.org
>
>

-
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org



Re: svn commit: r1042610 - /commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java

2010-12-07 Thread Gilles Sadowski
> >> I don't think it is right to leave the user totally in the dark as to
> >> how to resolve the deprecation warnings.
> >
> > There is no possible resolution in 2.2. The deprecation warning says: "You
> > will have to modify that code when upgrading to 3.0".
> 
> In which case the upgrade path should be mentioned elsewhere in the
> release documentation.
> 
> But if we already know what the methods are in 3.0, why not add a note
> to the class Javadoc to give the user the information they need?

OK. I'll do that.


Gilles

-
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org



Re: svn commit: r1042610 - /commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java

2010-12-07 Thread Phil Steitz




On Dec 7, 2010, at 7:19 AM, sebb  wrote:

> On 7 December 2010 09:18, Gilles Sadowski  
> wrote:
>> Hi.
>> 
>>> On 6 December 2010 22:21, Gilles Sadowski  
>>> wrote:
 - * @deprecated in 2.2 (to be removed in 3.0). Please use
 - * {...@link #map(UnivariateRealFunction)} directly with
 - * the function classes in package
 - * {...@link org.apache.commons.math.analysis.function}.
 + * @deprecated in 2.2 (to be removed in 3.0).
>>> 
>>> Why not leave the reference to #map(UnivariateRealFunction) ?
>> 
>> Because the package "function" does not exist in MATH_2_X.
> 
> I know that, but #map(UnivariateRealFunction) does exist (in the same
> source file).
> 
> It was only the reference to the package name that was wrong.
> 
> If the replacement for the deprecated methods is not
> #map(UnivariateRealFunction), then whatever is the replacement should
> be specified in the Javadoc.
 
 The replacement is the method "map" (which exists) together with the
 appropriate function (which doesn't, unless someone wants to backport the
 "function" package).
>>> 
>>> There are several implementations of UnivariateRealFunction, e.g.
>>> PolynomialFunctionLagrangeForm.
>>> 
>>> Are these not suitable as parameters to the map method?
>> 
>> They are, but they do not provide a replacement for the deprecated methods,
>> which is the point of a more detailed deprecation message.
>> 
 I think that we agreed with Phil that when the replacement doesn't exist, 
 it
 is sufficient to warn the users with a terse deprecation message.
>>> 
>>> I don't think it is right to leave the user totally in the dark as to
>>> how to resolve the deprecation warnings.
>> 
>> There is no possible resolution in 2.2. The deprecation warning says: "You
>> will have to modify that code when upgrading to 3.0".
> 
> In which case the upgrade path should be mentioned elsewhere in the
> release documentation.
> 
> But if we already know what the methods are in 3.0, why not add a note
> to the class Javadoc to give the user the information they need?
> 
I am now regretting having opened this can of worms.  The 3.0 API is evolving 
and we are trying to do as good a job as we can including deprecations in 2.2 
for things we know are going to be removed in 3.0. Beyond "terse" deprecations, 
I don't think it's reasonable to try to maintain documentation on the 
still-evolving 3.0 API in the 2.x branch.

Phil


>> 
>> Regards,
>> Gilles
>> 
>> -
>> To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
>> For additional commands, e-mail: dev-h...@commons.apache.org
>> 
>> 
> 
> -
> To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
> For additional commands, e-mail: dev-h...@commons.apache.org
> 

-
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org



Re: svn commit: r1042610 - /commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java

2010-12-07 Thread Luc Maisonobe
Le 07/12/2010 14:59, Phil Steitz a écrit :
> 
> 
> 
> 
> On Dec 7, 2010, at 7:19 AM, sebb  wrote:
> 
>> On 7 December 2010 09:18, Gilles Sadowski  
>> wrote:
>>> Hi.
>>>
 On 6 December 2010 22:21, Gilles Sadowski  
 wrote:
> - * @deprecated in 2.2 (to be removed in 3.0). Please use
> - * {...@link #map(UnivariateRealFunction)} directly with
> - * the function classes in package
> - * {...@link org.apache.commons.math.analysis.function}.
> + * @deprecated in 2.2 (to be removed in 3.0).

 Why not leave the reference to #map(UnivariateRealFunction) ?
>>>
>>> Because the package "function" does not exist in MATH_2_X.
>>
>> I know that, but #map(UnivariateRealFunction) does exist (in the same
>> source file).
>>
>> It was only the reference to the package name that was wrong.
>>
>> If the replacement for the deprecated methods is not
>> #map(UnivariateRealFunction), then whatever is the replacement should
>> be specified in the Javadoc.
>
> The replacement is the method "map" (which exists) together with the
> appropriate function (which doesn't, unless someone wants to backport the
> "function" package).

 There are several implementations of UnivariateRealFunction, e.g.
 PolynomialFunctionLagrangeForm.

 Are these not suitable as parameters to the map method?
>>>
>>> They are, but they do not provide a replacement for the deprecated methods,
>>> which is the point of a more detailed deprecation message.
>>>
> I think that we agreed with Phil that when the replacement doesn't exist, 
> it
> is sufficient to warn the users with a terse deprecation message.

 I don't think it is right to leave the user totally in the dark as to
 how to resolve the deprecation warnings.
>>>
>>> There is no possible resolution in 2.2. The deprecation warning says: "You
>>> will have to modify that code when upgrading to 3.0".
>>
>> In which case the upgrade path should be mentioned elsewhere in the
>> release documentation.
>>
>> But if we already know what the methods are in 3.0, why not add a note
>> to the class Javadoc to give the user the information they need?
>>
> I am now regretting having opened this can of worms.  The 3.0 API is evolving 
> and we are trying to do as good a job as we can including deprecations in 2.2 
> for things we know are going to be removed in 3.0. Beyond "terse" 
> deprecations, I don't think it's reasonable to try to maintain documentation 
> on the still-evolving 3.0 API in the 2.x branch.

I think we should push 2.2 out as fast as possible (i.e. before
Christmas) and concentrate the few cycles we have available to 3.0.

Luc

> Phil
> 
> 
>>>
>>> Regards,
>>> Gilles
>>>
>>> -
>>> To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
>>> For additional commands, e-mail: dev-h...@commons.apache.org
>>>
>>>
>>
>> -
>> To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
>> For additional commands, e-mail: dev-h...@commons.apache.org
>>
> 
> -
> To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
> For additional commands, e-mail: dev-h...@commons.apache.org
> 
> 


-
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org



Re: svn commit: r1042610 - /commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java

2010-12-07 Thread Gilles Sadowski
> 
> I think we should push 2.2 out as fast as possible (i.e. before
> Christmas) and concentrate the few cycles we have available to 3.0.

+1

And targetting spring for 3.0 ?


Gilles

-
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org



Re: svn commit: r1042610 - /commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/linear/RealVector.java

2010-12-08 Thread Luc Maisonobe
Le 08/12/2010 00:10, Gilles Sadowski a écrit :
>>
>> I think we should push 2.2 out as fast as possible (i.e. before
>> Christmas) and concentrate the few cycles we have available to 3.0.
> 
> +1
> 
> And targetting spring for 3.0 ?

Yes, that would be nice.

Luc

> 
> 
> Gilles
> 
> -
> To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
> For additional commands, e-mail: dev-h...@commons.apache.org
> 
> 


-
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org