package de.lmu.ifi.dbs.elki.parallel.variables;

/*
 This file is part of ELKI:
 Environment for Developing KDD-Applications Supported by Index-Structures

 Copyright (C) 2015
 Ludwig-Maximilians-Universität München
 Lehr- und Forschungseinheit für Datenbanksysteme
 ELKI Development Team

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Direct channel connecting two processors.
 * 
 * @author Erich Schubert
 * @since 0.7.0
 * 
 * @apiviz.has SharedDouble.Instance
 */
public class SharedDouble implements SharedVariable<SharedDouble.Instance> {
  @Override
  public Instance instantiate() {
    return new Instance();
  }

  /**
   * Instance for a sub-channel.
   * 
   * @author Erich Schubert
   */
  public static class Instance implements SharedVariable.Instance<Double> {
    /**
     * Cache for last data consumed/produced
     */
    private double data = Double.NaN;

    /**
     * @deprecated use {@link #doubleValue}!
     */
    @Deprecated
    @Override
    public Double get() {
      return data;
    }

    /**
     * @deprecated use {@link #set(double)}!
     */
    @Deprecated
    @Override
    public void set(Double data) {
      this.data = data;
    }

    /**
     * Get the variables value.
     * 
     * @return Double value
     */
    public double doubleValue() {
      return data;
    }

    /**
     * Set the variables value.
     * 
     * @param data New value
     */
    public void set(double data) {
      this.data = data;
    }
  }
}