gov.sandia.cognition.math.Field 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:            Field.java
 * Authors:         Justin Basilico
 * Project:         Cognitive Foundry Common Core
 * 
 * Copyright 2013, Cognitive Foundry. All rights reserved.
 */

package gov.sandia.cognition.math;

import gov.sandia.cognition.annotation.PublicationReference;
import gov.sandia.cognition.annotation.PublicationType;

/**
 * Defines something similar to a mathematical field. It extends a ring and
 * allows division to be defined for all non-zero values.
 *
 * @param   
 *      The type of field.
 * @author  Justin Basilico
 * @version 3.3.3
 */
@PublicationReference(
    author="Wikipedia",
    title="Field (mathematics)",
    type=PublicationType.WebPage,
    year=2013,
    url="http://en.wikipedia.org/wiki/Field_(mathematics))"
)
public interface Field>
    extends EuclideanRing
{
    
    /**
     * Returns the inverse of {@code this}.
     *
     * @return
     *      The inverse of this field.
     */
    public FieldType inverse();

    /**
     * Changes this value to be its inverse.
     */
    public void inverseEquals();
    
}