gov.sandia.cognition.math.matrix.SparseVectorFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cognitive-foundry Show documentation

A single jar with all the Cognitive Foundry components.

There is a newer version: 4.0.1

/*
 * File:                SparseVectorFactory.java
 * Authors:             Justin Basilico
 * Company:             Sandia National Laboratories
 * Project:             Cognitive Foundry
 *
 * Copyright March 12, 2009, Sandia Corporation.
 * Under the terms of Contract DE-AC04-94AL85000, there is a non-exclusive
 * license for use of this work by or on behalf of the U.S. Government. Export
 * of this program may require a license from the United States Government.
 * See CopyrightHistory.txt for complete details.
 *
 */

package gov.sandia.cognition.math.matrix;


/**
 * Abstract factory class for creating sparse vectors.
 *
 * @param  Type of Vector created by the VectorFactory.
 * @author  Justin Basilico
 * @since   3.0
 */
public abstract class SparseVectorFactory
    extends VectorFactory
{

    /**
     * Gets the default instance.
     * @return
     * Default instance of the SparseVectorFactory
     */
    public static SparseVectorFactory getDefault()
    {
        return DEFAULT_SPARSE_INSTANCE;
    }

    /**
     * Creates a new, empty vector with the given dimensionality and expected
     * number of nonzero elements.
     *
     * @param   dimensionality
     *      The dimensionality for the vector to create.
     * @param   initialCapacity
     *      The expected initial number of nonzero elements of the vector to
     *      create.
     * @return
     *      A new sparse vector with the given dimensionality and number of
     *      nonzeros.
     */
    public abstract VectorType createVectorCapacity(
        final int dimensionality,
        final int initialCapacity);
    
}