001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.math4.neuralnet.twod.util;
019
020import org.apache.commons.math4.neuralnet.twod.NeuronSquareMesh2D;
021
022/**
023 * Interface for algorithms that compute some metrics of the projection of
024 * data on a 2D-map.
025 * @since 3.6
026 */
027public interface MapDataVisualization {
028    /**
029     * Creates an image of the {@code data} metrics when represented by the
030     * {@code map}.
031     *
032     * @param map Map.
033     * @param data Data.
034     * @return a 2D-array (in row major order) representing the metrics.
035     */
036    double[][] computeImage(NeuronSquareMesh2D map,
037                            Iterable<double[]> data);
038}