src/main/java/org/apache/commons/math3/linear/SparseRealVector.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

/*
 * 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.commons.math3.linear;

/**
 * Marker class for RealVectors that require sparse backing storage
 *
 * <p>Caveat: Implementation are allowed to assume that, for any {@code x}, the equality {@code x *
 * 0d == 0d} holds. But it is is not true for {@code NaN}. Moreover, zero entries will lose their
 * sign. Some operations (that involve {@code NaN} and/or infinities) may thus give incorrect
 * results, like multiplications, divisions or functions mapping.
 *
 * @since 2.0
 */
public abstract class SparseRealVector extends RealVector {}