smile.data.NominalAttribute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openchemlib Show documentation
Open Source Chemistry Library
There is a newer version: 2024.11.2
/*******************************************************************************
 * Copyright (c) 2010 Haifeng Li
 *   
 * Licensed 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 smile.data;

import java.text.ParseException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;

/**
 * Nominal attribute. Nominal attributes are defined on a list of the unordered
 * values.
 *
 * @author Haifeng Li
 */
public class NominalAttribute extends Attribute {

    /**
     * True if the string values of the nominal attribute is a open set.
     * The new string values will be added into the attribute when calling
     * the method valueOf(String).
     */
    private boolean open = true;
    /**
     * The string values of the nominal attribute.
     */
    private List values;
    /**
     * Map a string to an integer level.
     */
    private HashMap map;

    /**
     * Constructor.
     * @param name the name of attribute.
     */
    public NominalAttribute(String name) {
        this(name, 1.0);
    }

    /**
     * Constructor.
     * @param name the name of attribute.
     */
    public NominalAttribute(String name, double weight) {
        this(name, null, weight);
    }

    /**
     * Constructor.
     * @param name the name of attribute.
     * @param description the detailed description of attribute.
     */
    public NominalAttribute(String name, String description) {
        this(name, description, 1.0);
    }

    /**
     * Constructor.
     * @param name the name of attribute.
     * @param description the detailed description of attribute.
     */
    public NominalAttribute(String name, String description, double weight) {
        super(Type.NOMINAL, name, description, weight);
        this.values = new ArrayList<>();
        this.map = new HashMap<>();
        this.open = true;
    }

    /**
     * Constructor.
     * @param name the name of attribute.
     * @param values the valid string values of nominal attribute.
     */
    public NominalAttribute(String name, String[] values) {
        this(name, 1.0, values);
    }

    /**
     * Constructor.
     * @param name the name of attribute.
     * @param values the valid string values of nominal attribute.
     */
    public NominalAttribute(String name, double weight, String[] values) {
        this(name, null, weight, values);
    }

    /**
     * Constructor.
     * @param name the name of attribute.
     * @param description the detailed description of attribute.
     * @param values the valid string values of nominal attribute.
     */
    public NominalAttribute(String name, String description, String[] values) {
        this(name, description, 1.0, values);
    }

    /**
     * Constructor.
     * @param name the name of attribute.
     * @param description the detailed description of attribute.
     * @param values the valid string values of nominal attribute.
     */
    public NominalAttribute(String name, String description, double weight, String[] values) {
        super(Type.NOMINAL, name, description, weight);
        this.values = new ArrayList<>();
        this.map = new HashMap<>();
        this.open = false;
        for (int i = 0; i < values.length; i++) {
            this.values.add(values[i]);
            this.map.put(values[i], i);
        }
    }

    /**
     * Returns the number of nominal values.
     * @return the number of nominal values 
     */
    public int size() {
        return values.size();
    }
    
    /**
     * Returns true if the string values of the nominal attribute is a open set.
     * The new string values will be added into the attribute when calling
     * the method valueOf(String).
     * @return true if the string values of the nominal attribute is a open set.
     */
    public boolean isOpen() {
        return open;
    }
    
    /**
     * Sets if the string values of the nominal attribute is a open set.
     * @param open true if the string values of the nominal attribute is a open set.
     */
    public void setOpen(boolean open) {
        this.open = open;
    }
    
    /**
     * Returns the string values of nominal attribute.
     */
    public String[] values() {
        return values.toArray(new String[values.size()]);
    }

    /**
     * Returns the ordinal value of a string value.
     */
    @Override
    public double valueOf(String s) throws ParseException {
        Integer i = map.get(s);
        if (i == null) {
            if (open) {
                i = values.size();
                map.put(s, i);
                values.add(s);
            } else {
                throw new ParseException("Invalid string value: " + s, 0);
            }
        }
        
        return i;
    }

    @Override
    public String toString(double x) {
        if (Double.isNaN(x)) {
            return null;
        }
        
        if (Math.floor(x) != x) {
            throw new IllegalArgumentException("The input nominal value is not an integer: " + x);
        }

        if (x < 0 || x >= values.size()) {
            throw new IllegalArgumentException("Invalid nominal value: " + x);
        }

        return values.get((int)x);
    }
}