/*
 * Copyright (c) 2005 Thomas Weise
 *
 * E-Mail           : tweise@gmx.de
 * Creation Date    : 2005-12-21 09:14:03
 * Original Filename: org.sfc.math.stochastic.statistics.ValueExtractor.java
 * Version          : 3.0.0
 * Last modification: 2006-04-10
 *                by: Thomas Weise
 *
 * License          : GNU LESSER GENERAL PUBLIC LICENSE
 *                    Version 2.1, February 1999
 *                    You should have received a copy of this license along
 *                    with this library; if not, write to the Free Software
 *                    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *                    MA 02111-1307, USA or download the license under
 *                    http://www.gnu.org/copyleft/lesser.html.
 *
 * Warranty         : This software is provided "as is" without any
 *                    warranty; without even the implied warranty of
 *                    merchantability or fitness for a particular purpose.
 *                    See the Gnu Lesser General Public License for more
 *                    details.
 */

package org.sfc.math.stochastic.statistics;

/**
 * With this class, you may obtain <code>double</code>-precision floating
 * point values from objects that represent direct/random accessible
 * sequences, such as arrays.
 *
 * @param <CollectionType>  The type of objects handled by this value getter.
 *                          This will normally be an array type or such and
 *                          such.
 * @author Thomas Weise
 */
public abstract class ValueExtractor<CollectionType>
  {
/**
 * The singleton instance for arrays of <code>double</code>.
 */
  public static final ValueExtractor<double[]> DOUBLE_ARRAY_INSTANCE =
      new ValueExtractor<double[]>()
        {
        @Override
        protected final double  get_value(final double[] p_collection,
                                          final int      p_index)
          {
          return p_collection[p_index];
          }
        };
//
///**
// * The singleton instance for arrays of <code>int</code>.
// */
//  public static final ValueExtractor<int[]> INT_ARRAY_INSTANCE =
//      new ValueExtractor<int[]>()
//        {
//        @Override
//        protected final double  get_value(final int[]    p_collection,
//                                          final int      p_index)
//          {
//          return p_collection[p_index];
//          }
//        };
//
//
///**
// * The singleton instance for arrays of <code>long</code>.
// */
//  public static final ValueExtractor<long[]> LONG_ARRAY_INSTANCE =
//      new ValueExtractor<long[]>()
//        {
//        @Override
//        protected final double  get_value(final long[]    p_collection,
//                                          final int       p_index)
//          {
//          return p_collection[p_index];
//          }
//        };
//
//
///**
// * The singleton instance for arrays of <code>float</code>.
// */
//  public static final ValueExtractor<float[]> FLOAT_ARRAY_INSTANCE =
//      new ValueExtractor<float[]>()
//        {
//        @Override
//        protected final double  get_value(final float[]   p_collection,
//                                          final int       p_index)
//          {
//          return p_collection[p_index];
//          }
//        };

/**
 * Obtain a double value from the item at position <code>p_index</code> in
 * the collection.
 * @param p_collection  The collection object to obtain the value from.
 * @param p_index       The index of the item to return the value of.
 * @return              The <code>double</code> representation of the item
 *                      at this position.
 */
  protected abstract  double  get_value(final CollectionType p_collection,
                                        final int            p_index);
  }