org.apache.sysml.runtime.functionobjects.SortIndex Maven / Gradle / Ivy

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

Declarative Machine Learning

There is a newer version: 1.2.0

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.sysml.runtime.functionobjects;


import org.apache.sysml.runtime.DMLRuntimeException;
import org.apache.sysml.runtime.matrix.data.MatrixValue.CellIndex;

/**
 * This index function is NOT used for actual sorting but just as a reference
 * in ReorgOperator in order to identify sort operations.
 * 
 */
public class SortIndex extends IndexFunction
{

	private static final long serialVersionUID = -8446389232078905200L;

	private int     _col        = -1;
	private boolean _decreasing = false;
	private boolean _ixreturn   = false;
	
	private SortIndex() {
		// nothing to do here
	}

	public static SortIndex getSortIndexFnObject(int col, boolean decreasing, boolean indexreturn) 
	{
		SortIndex ix = new SortIndex();
		ix._col = col;
		ix._decreasing = decreasing;
		ix._ixreturn = indexreturn;
		
		return ix;
	}

	public int getCol() {
		return _col;
	}
	
	public boolean getDecreasing() {
		return _decreasing;
	}
	
	public boolean getIndexReturn() {
		return _ixreturn;
	}
	
	public Object clone() throws CloneNotSupportedException {
		// cloning is not supported for singleton classes
		throw new CloneNotSupportedException();
	}
	
	public boolean computeDimension(int row, int col, CellIndex retDim) 
		throws DMLRuntimeException 
	{
		retDim.set(row, _ixreturn?1:col);
		return false;
	}
	

}