You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by "Sébastien Brisard (JIRA)" <ji...@apache.org> on 2012/10/08 08:00:09 UTC

[jira] [Updated] (MATH-875) Deprecate RealVector.sparseIterator()

     [ https://issues.apache.org/jira/browse/MATH-875?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Sébastien Brisard updated MATH-875:
-----------------------------------

          Description: 
Following MATH-870, {{RealVector.sparseIterator()}} has become useless. Its interface was confusing. Indeed, the Javadoc states

{quote}
Specialized implementations may choose to not iterate over all dimensions, either because those values are unset, or are equal to defaultValue(), or are small enough to be ignored for the purposes of iteration.
{quote}

The reference to {{defaultValue()}} (which does *not* exist) suggests that the interface offers the flexibility to chose the value which is not stored in the sparse implementation. On the other hand, "small enough to be ignored" suggests that this default value is zero.

In version 3.1, this method will be deprecated, to be removed in 4.0.

  was:
Following MATH-870, {{RealVector.sparseIterator()}} and {{FieldVector.sparseIterator()}} have become useless. Their interface was confusing. Indeed, the Javadoc states

{quote}
Specialized implementations may choose to not iterate over all dimensions, either because those values are unset, or are equal to defaultValue(), or are small enough to be ignored for the purposes of iteration.
{quote}

The reference to {{defaultValue()}} (which does *not* exist) suggests that the interface offers the flexibility to chose the value which is not stored in the sparse implementation. On the other hand, "small enough to be ignored" suggests that this default value is zero.

In version 3.1, this method will be deprecated, to be removed in 4.0.

    Affects Version/s:     (was: 3.1)
              Summary: Deprecate RealVector.sparseIterator()  (was: Deprecate RealVector.sparseIterator() and FieldVector.sparseIterator())
    
> Deprecate RealVector.sparseIterator()
> -------------------------------------
>
>                 Key: MATH-875
>                 URL: https://issues.apache.org/jira/browse/MATH-875
>             Project: Commons Math
>          Issue Type: Improvement
>    Affects Versions: 4.0
>            Reporter: Sébastien Brisard
>            Priority: Minor
>              Labels: linear, sparse
>
> Following MATH-870, {{RealVector.sparseIterator()}} has become useless. Its interface was confusing. Indeed, the Javadoc states
> {quote}
> Specialized implementations may choose to not iterate over all dimensions, either because those values are unset, or are equal to defaultValue(), or are small enough to be ignored for the purposes of iteration.
> {quote}
> The reference to {{defaultValue()}} (which does *not* exist) suggests that the interface offers the flexibility to chose the value which is not stored in the sparse implementation. On the other hand, "small enough to be ignored" suggests that this default value is zero.
> In version 3.1, this method will be deprecated, to be removed in 4.0.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira