/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.mahout.cf.taste.impl.similarity;

import org.apache.mahout.cf.taste.model.DataModel;
import org.junit.Test;

/** <p>Tests {@link SpearmanCorrelationSimilarity}.</p> */
public final class SpearmanCorrelationSimilarityTest extends SimilarityTestCase {

  @Test
  public void testFullCorrelation1() throws Exception {
    DataModel dataModel = getDataModel(
            new long[] {1, 2},
            new Double[][] {
                    {1.0, 2.0, 3.0},
                    {1.0, 2.0, 3.0},
            });
    double correlation = new SpearmanCorrelationSimilarity(dataModel).userSimilarity(1, 2);
    assertCorrelationEquals(1.0, correlation);
  }

  @Test
  public void testFullCorrelation2() throws Exception {
    DataModel dataModel = getDataModel(
            new long[] {1, 2},
            new Double[][] {
                    {1.0, 2.0, 3.0},
                    {4.0, 5.0, 6.0},
            });
    double correlation = new SpearmanCorrelationSimilarity(dataModel).userSimilarity(1, 2);
    assertCorrelationEquals(1.0, correlation);
  }

  @Test
  public void testAnticorrelation() throws Exception {
    DataModel dataModel = getDataModel(
            new long[] {1, 2},
            new Double[][] {
                    {1.0, 2.0, 3.0},
                    {3.0, 2.0, 1.0},
            });
    double correlation = new SpearmanCorrelationSimilarity(dataModel).userSimilarity(1, 2);
    assertCorrelationEquals(-1.0, correlation);
  }

  @Test
  public void testSimple() throws Exception {
    DataModel dataModel = getDataModel(
            new long[] {1, 2},
            new Double[][] {
                    {1.0, 2.0, 3.0},
                    {2.0, 3.0, 1.0},
            });
    double correlation = new SpearmanCorrelationSimilarity(dataModel).userSimilarity(1, 2);
    assertCorrelationEquals(-0.5, correlation);
  }

  @Test
  public void testRefresh() {
    // Make sure this doesn't throw an exception
    new SpearmanCorrelationSimilarity(getDataModel()).refresh(null);
  }

}
