1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.math4.neuralnet.twod.util;
19
20 import org.apache.commons.math4.neuralnet.twod.NeuronSquareMesh2D;
21
22 /**
23 * Interface for algorithms that compute some metrics of the projection of
24 * data on a 2D-map.
25 * @since 3.6
26 */
27 public interface MapDataVisualization {
28 /**
29 * Creates an image of the {@code data} metrics when represented by the
30 * {@code map}.
31 *
32 * @param map Map.
33 * @param data Data.
34 * @return a 2D-array (in row major order) representing the metrics.
35 */
36 double[][] computeImage(NeuronSquareMesh2D map,
37 Iterable<double[]> data);
38 }