com.siemens.industrialbenchmark.datavector.DataVectorDescription.java Source code

Introduction

Here is the source code for com.siemens.industrialbenchmark.datavector.DataVectorDescription.java

Source

/**
Copyright 2016 Siemens AG.
    
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 com.siemens.industrialbenchmark.datavector;

import java.util.List;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableList.Builder;

/**
 * state/action description for the industrial benchmark
 */
abstract public class DataVectorDescription {
    protected List<String> names;

    /**
     * Constructor with a given List of state/action dimension names
     * @param names
     */
    public DataVectorDescription(List<String> names) {
        Preconditions.checkNotNull(names, "name list must not be null.");
        Preconditions.checkArgument(names.size() > 0, "name list has size 0");

        Builder<String> lb = ImmutableList.builder();
        for (String key : names) {
            lb.add(key);
        }
        this.names = lb.build();
    }

    /**
     * Constructor with a given set of state/action description names
     * @param names
     */
    public DataVectorDescription(String names[]) {
        Preconditions.checkNotNull(names, "name list must not be null.");
        Preconditions.checkArgument(names.length > 0, "name list has size 0");

        Builder<String> lb = ImmutableList.builder();
        for (String key : names) {
            lb.add(key);
        }
        this.names = lb.build();
    }

    /**
     * Returns the number of variables
     * @return the number of variables
     */
    public int getNumberVariables() {
        return names.size();
    }

    /**
     * returns a List containing the variable names
     * @return A List containing the variable names
     */
    public List<String> getVarNames() {
        return names;
    }

    @Override
    public boolean equals(Object o) {
        DataVectorDescription os = (DataVectorDescription) o;
        return names.equals(os.getVarNames());
    }

    @Override
    public String toString() {
        return names.toString();
    }
}