Dimension.java

/*
 * Copyright (c) 2013, SRI International
 * All rights reserved.
 * Licensed under the The BSD 3-Clause License;
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 * 
 * http://opensource.org/licenses/BSD-3-Clause
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of the aic-util nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.sri.ai.util.rangeoperation.library.rangeoperations;

import java.util.Collection;
import java.util.List;

import com.google.common.annotations.Beta;
import com.sri.ai.util.rangeoperation.api.Range;
import com.sri.ai.util.rangeoperation.core.DefaultRangeOperation;
import com.sri.ai.util.rangeoperation.library.operators.Concatenate;
import com.sri.ai.util.rangeoperation.library.ranges.DiscreteRange;
import com.sri.ai.util.rangeoperation.library.ranges.GeometricIntegerRange;
import com.sri.ai.util.rangeoperation.library.ranges.IntegerRange;

/** An operation concatenating values into a list, with {@link Concatenate}. */
@Beta
public class Dimension<T> extends DefaultRangeOperation<T, List<T>> {
	
	public Dimension(Range<T> range) {
		super(new Concatenate<T>(), range);
	}
	
	/** 
	 * Creates an axis on a discrete range.
	 * 
	 *  @param name
	 *         the name for the dimension.
	 *  @param collection
	 *         the discrete range.
	 */
	public Dimension(String name, Collection<T> collection) {
		this(new DiscreteRange<T>(name, collection));
	}
	
	@SuppressWarnings("unchecked")
	public Dimension(String name, final int first, final int last, final int step) {
		this((Range<T>) new IntegerRange(name, first, last, step));
	}
	
	public Dimension(String name, final int first, final int last) {
		this(name, first, last, 1);
	}
	
	/** 
	 * Creates an axis on a geometric integer series.
	 * 
	 * @param name
	 *        the name for the dimension.
	 * @param first
	 *        the first value in the series.
	 * @param last
	 *        the last value in the series.
	 * @param rate
	 *        the rate of the series.
	 */
	@SuppressWarnings("unchecked")
	public Dimension(String name, final int first, final int last, final float rate) {
		this((Range<T>) new GeometricIntegerRange(name, first, last, rate));
	}
}