Merge pull request #3071 from curiousguy13/linalg_range_fill

added rangeFill for linalg

src/shogun/mathematics/linalg/internal/implementation/RangeFill.h

@@ -0,0 +1,105 @@
+/*
+ * Copyright (c) The Shogun Machine Learning Toolbox
+ * Written (w) 2016 Kunal Arora
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 2. 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.
+ *
+ * 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 OWNER 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.
+ *
+ * The views and conclusions contained in the software and documentation are those
+ * of the authors and should not be interpreted as representing official policies,
+ * either expressed or implied, of the Shogun Development Team.
+ */
+
+#ifndef RANGE_FILL_IMPL_H_
+#define RANGE_FILL_IMPL_H_
+
+#include <shogun/lib/config.h>
+#include <shogun/lib/SGVector.h>
+#include <shogun/lib/SGMatrix.h>
+
+#include <numeric>
+
+namespace shogun
+{
+
+namespace linalg
+{
+
+namespace implementation
+{
+
+/**
+ * @brief Generic class which is specialized for different backends to perform the Range fill operation
+ */
+template <enum Backend, class Matrix>
+struct range_fill
+{
+	/**Scalar type */
+	typedef typename Matrix::Scalar T;
+
+	/**Range fill a vector with start...start+len-1
+	 * @param A - the matrix to be filled
+	 * @param start - value to be assigned to first element of vector
+	 */
+	static void compute(Matrix A, T start);
+
+};
+
+/**
+ * @brief Partial specialization of add for the Eigen3 backend
+ */
+template <class Matrix>
+struct range_fill<Backend::EIGEN3, Matrix>
+{
+	/** Scalar type */
+	typedef typename Matrix::Scalar T;
+
+	/** Eigen3 vector type */
+	typedef Eigen::Matrix<T,Eigen::Dynamic,1> VectorXt;
+
+	/**Range fill a vector with start...start+len-1
+	 * @param A - the vector to be filled
+	 * @param start - value to be assigned to first element of vector or matrix
+	 */
+	static void compute(SGVector<T> A, T start)
+	{
+		compute(A, A.size(), start);
+	}
+
+	/** Range fill a vector array with start...start+len-1
+	 * @param A - the array to be filled
+	 * @param len - length of the array to be filled
+	 * @param start - value to be assigned to first element of array
+	 */
+	static void compute(SGVector<T> A, index_t len, T start)
+	{
+		Eigen::Map<VectorXt> A_eig=A;
+		A_eig.setLinSpaced(len, start, A.size()+start-1);
+	}
+
+};
+
+}
+
+}
+
+}
+#endif //RANGE_FILL_IMPL_H_

src/shogun/mathematics/linalg/internal/modules/Core.h

@@ -39,6 +39,7 @@
 #include <shogun/mathematics/linalg/internal/implementation/ElementwiseProduct.h>
 #include <shogun/mathematics/linalg/internal/implementation/Scale.h>
 #include <shogun/mathematics/linalg/internal/implementation/Convolve.h>
+#include <shogun/mathematics/linalg/internal/implementation/RangeFill.h>
 
 namespace shogun
 {
@@ -102,6 +103,27 @@ void scale(Matrix A, typename Matrix::Scalar alpha)
 	implementation::scale<backend, Matrix>::compute(A, A, alpha);
 }
 
+/** Range fill a vector with start...start+len-1
+ * @param A - the matrix to be filled
+ * @param start - value to be assigned to first element of vector or matrix
+ */
+template <Backend backend=linalg_traits<Core>::backend, class Matrix>
+void range_fill(Matrix A, typename Matrix::Scalar start=0.0)
+{
+	implementation::range_fill<backend, Matrix>::compute(A, start);
+}
+
+/** Range fill a vector array with start...start+len-1
+ * @param A - the array to be filled
+ * @param len - length of the array to be filled
+ * @param start - value to be assigned to first element of array
+ */
+template <Backend backend=linalg_traits<Core>::backend, class Matrix>
+void range_fill(Matrix A, index_t len, typename Matrix::Scalar start=0.0)
+{
+	implementation::range_fill<backend, Matrix>::compute(A, len, start);
+}
+
 #ifdef HAVE_LINALG_LIB
 /** Performs the operation of matrix applied to a vector \f$x = Ab\f$.
  *

tests/unit/mathematics/linalg/RangeFill_unittest.cc

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) The Shogun Machine Learning Toolbox
+ * Written (w) 2016 Kunal Arora
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 2. 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.
+ *
+ * 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 OWNER 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.
+ *
+ * The views and conclusions contained in the software and documentation are those
+ * of the authors and should not be interpreted as representing official policies,
+ * either expressed or implied, of the Shogun Development Team.
+ */
+
+#include <shogun/lib/config.h>
+
+#ifdef HAVE_LINALG_LIB
+#include <shogun/mathematics/linalg/linalg.h>
+#include <shogun/lib/SGMatrix.h>
+#include <shogun/lib/SGVector.h>
+#include <gtest/gtest.h>
+
+using namespace shogun;
+
+//test when start=0.0
+TEST(RangeFillVector, eigen3_backend_start0)
+{
+	SGVector<float64_t> v(4);
+	linalg::range_fill<linalg::Backend::EIGEN3>(v,0.0);
+	EXPECT_EQ(v.vlen, 4);
+	for(int32_t i=0;i<4;i++)
+		EXPECT_NEAR(v[i], i, 1e-9);
+}
+
+//test when start not given as input
+TEST(RangeFillVector, eigen3_backend_no_start)
+{
+	SGVector<float64_t> v(4);
+	linalg::range_fill<linalg::Backend::EIGEN3>(v);
+	EXPECT_EQ(v.vlen, 4);
+	for(int32_t i=0;i<4;i++)
+		EXPECT_NEAR(v[i], i, 1e-9);
+}
+//test when start>0
+TEST(RangeFillVector, eigen3_backend_start_greaterThan_0)
+{
+	SGVector<float64_t> v(4);
+	linalg::range_fill<linalg::Backend::EIGEN3>(v,5.0);
+	EXPECT_EQ(v.vlen, 4);
+	for(int32_t i=0;i<4;i++)
+		EXPECT_NEAR(v[i], i+5.0, 1e-9);
+}
+
+//test for negative values
+TEST(RangeFillVector, eigen3_backend_start_lessThan_0)
+{
+	SGVector<float64_t> v(4);
+	linalg::range_fill<linalg::Backend::EIGEN3>(v,-5.0);
+	EXPECT_EQ(v.vlen, 4);
+	for(int32_t i=0;i<4;i++)
+		EXPECT_NEAR(v[i], i-5.0, 1e-9);
+}
+
+#endif // defined(HAVE_LINALG_LIB)