org.openml.apiconnector.models.Metric Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apiconnector Show documentation

Ancestor for API connector libraries for specific frameworks.

There is a newer version: 1.0.30

/*
 *  OpenmlApiConnector - Java integration of the OpenML Web API
 *  Copyright (C) 2014 
 *  @author Jan N. van Rijn ([email protected])
 *  
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *  
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *  
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see .
 *  
 */
package org.openml.apiconnector.models;

import org.apache.commons.lang3.builder.HashCodeBuilder;

public class Metric {

	public String name;
	public String implementation;
	
	/**
	 * @param name - Name of the evaluation metric. Corresponds to name in OpenML table "math_function"
	 * @param implementation - Name of the implementation of this metric. Corresponds to fullName in OpenML table "implementation"
	 * @param label - Label of the metric. For example, a precision score "could" have a have a label specifying for which class it is. 
	 */
	public Metric( String name, String implementation ) {
		this.name = name;
		this.implementation = implementation;
	}
	
	@Override
	public boolean equals( Object o ) {
		if( o instanceof Metric ) {

			Metric other = (Metric) o;
			
			
			return other.name.equals(this.name) && other.implementation.equals(implementation);
			
		} else {
			return false;
		}
	}
	
	@Override
	public int hashCode() {
        return new HashCodeBuilder(17, 31).append(name).append(implementation).toHashCode();
    }
	
	@Override
	public String toString() {
		return implementation;
	}
}