001    // --- BEGIN LICENSE BLOCK ---
002    /* 
003     * Copyright (c) 2009, Mikio L. Braun
004     * All rights reserved.
005     * 
006     * Redistribution and use in source and binary forms, with or without
007     * modification, are permitted provided that the following conditions are
008     * met:
009     * 
010     *     * Redistributions of source code must retain the above copyright
011     *       notice, this list of conditions and the following disclaimer.
012     * 
013     *     * Redistributions in binary form must reproduce the above
014     *       copyright notice, this list of conditions and the following
015     *       disclaimer in the documentation and/or other materials provided
016     *       with the distribution.
017     * 
018     *     * Neither the name of the Technische Universit?t Berlin nor the
019     *       names of its contributors may be used to endorse or promote
020     *       products derived from this software without specific prior
021     *       written permission.
022     * 
023     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
024     * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
025     * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
026     * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
027     * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
028     * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
029     * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
030     * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
031     * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
032     * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
033     * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
034     */
035    // --- END LICENSE BLOCK ---
036    
037    /*
038     * To change this template, choose Tools | Templates
039     * and open the template in the editor.
040     */
041    
042    package org.jblas.ranges;
043    
044    import org.jblas.*;
045    
046    /**
047     * A bunch of static functions for making construction of ranges more
048     * uniform. Basically, we have
049     * <ul>
050     * <li>point(3) - a PointRange.
051     * <li>indices(new int[] {1,2,3,...}) - a Indices Range.
052     * <li>interval(1, 2) - an interval range.
053     * <li>all() - an AllRange.
054     * <li>indices(x) - with a DoubleMatrix.
055     * <li>find(x) - an index constructed from the non-zero elements of x.
056     * </ul>
057     * 
058     */
059    public class RangeUtils {
060        /** Construct point range (constant range) with given index. */
061        public static Range point(int i) {
062            return new PointRange(i);
063        }
064        
065        public static Range indices(int[] is) {
066            return new IndicesRange(is);
067        }
068        
069        public static Range interval(int a, int b) {
070            return new IntervalRange(a, b);
071        }
072        
073        public static Range all() {
074            return new AllRange();
075        }
076        
077        public static Range indices(DoubleMatrix is) {
078            return new IndicesRange(is);
079        }
080        
081        public static Range find(DoubleMatrix is) {
082            return new IndicesRange(is.findIndices());
083        }
084    }