Documentation fixes for 3.1 release

pradeep · pradeep · commit 41d517e05687 · 2015-08-27T15:59:41.000-04:00
diff --git a/docs/details/data.dox b/docs/details/data.dox
@@ -33,7 +33,24 @@ The distribution is centered around 0
 \ingroup data_mat
 \ingroup arrayfire_func
 
-=======================================================================
+
+\defgroup data_func_setseed setSeed
+
+\brief Set the seed for random number generator
+
+
+\ingroup data_mat
+\ingroup arrayfire_func
+
+
+\defgroup data_func_getseed getSeed
+
+\brief Get the seed for random number generator
+
+
+\ingroup data_mat
+\ingroup arrayfire_func
+
 
 \defgroup data_func_identity identity
 
diff --git a/docs/details/image.dox b/docs/details/image.dox
@@ -790,7 +790,7 @@ unwrap(A, 3, 3, 3, 3, 2, 2) [9 9 1 1]
 \defgroup image_func_wrap wrap
 \ingroup image_mod_mat
 
-Wrap takes an unwrapped image (see \ref unwrap) and converts it back to an image.
+Wrap takes an unwrapped image (see \ref unwrap()) and converts it back to an image.
 
 The inputs to this function should be the same as the inputs used to generate the unwrapped image.
 @}
diff --git a/docs/details/lapack.dox b/docs/details/lapack.dox
@@ -140,7 +140,7 @@ The arrayfire function only returns the non zero diagonal elements of **S**. To
 
 \snippet test/svd_dense.cpp ex_svd_reg
 
-When memory is a concern, and **A** is dispensible, \ref svdInPlace can be used
+When memory is a concern, and **A** is dispensible, \ref svdInPlace() can be used
 
 
 =======================================================================
diff --git a/docs/details/util.dox b/docs/details/util.dox
@@ -71,7 +71,7 @@ An file with 2 arrays would look like (representative)
 > Array 2 Dims\n
 > Array 2 Data\n
 
-\ingroup stream_func
+\ingroup dataio_mat
 \ingroup arrayfire_func
 
 =======================================================================
@@ -129,7 +129,7 @@ On each append, the array counter in the header is incremented and the new
 array is written to the end of the file. This function does not check if the
 tag is unique or not.
 
-\ingroup stream_func
+\ingroup dataio_mat
 \ingroup arrayfire_func
 
 =======================================================================
diff --git a/docs/doxygen.mk b/docs/doxygen.mk
@@ -1978,7 +1978,8 @@ INCLUDE_FILE_PATTERNS  =
 PREDEFINED             = __declspec(x)= \
                          __attribute__(x)= \
                          __cplusplus \
-                         AF_DOC
+                         AF_DOC \
+						 AF_API_VERSION=${AF_API_VERSION_CURRENT}
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The
diff --git a/docs/pages/README.md b/docs/pages/README.md
@@ -130,8 +130,7 @@ af_print(pi);
 
 ## Citations and Acknowledgements
 
-If you redistribute ArrayFire, please follow the terms established in
-[the license](LICENSE).
+If you redistribute ArrayFire, please follow the terms established in <a href="https://github.com/arrayfire/arrayfire/blob/master/LICENSE">the license</a>.
 If you wish to cite ArrayFire in an academic publication, please use the
 following reference:
 
@@ -156,5 +155,4 @@ year = {2015}
 }
 ```
 
-ArrayFire development is funded by ArrayFire LLC and several third parties,
-please see the list of [acknowledgements](https://github.com/arrayfire/arrayfire/blob/master/ACKNOWLEDGEMENTS.md) for further details.
+ArrayFire development is funded by ArrayFire LLC and several third parties, please see the list of <a href="https://github.com/arrayfire/arrayfire/blob/master/ACKNOWLEDGEMENTS.md">acknowledgements</a>.
diff --git a/docs/pages/release_notes.md b/docs/pages/release_notes.md
@@ -7,10 +7,10 @@ v3.1.0
 Function Additions
 ------------------
 * Computer Vision Functions
-    * Nearest Neighbour with SAD, SSD and SHD distances (nearestNeighbour)
-    * Harris Corner Detector (harris)
-    * Susan Corner Detector (susan)
-    * Scale Invariant Feature Transform (SIFT)
+    * \ref nearestNeighbour() - Nearest Neighbour with SAD, SSD and SHD distances
+    * \ref harris() - Harris Corner Detector
+    * \ref susan() - Susan Corner Detector
+    * \ref sift() - Scale Invariant Feature Transform (SIFT)
         * Method and apparatus for identifying scale invariant features"
           "in an image and use of same for locating an object in an image,\" David"
           "G. Lowe, US Patent 6,711,293 (March 23, 2004). Provisional application"
@@ -20,36 +20,50 @@ Function Additions
           "Columbia.")
         * SIFT is available for compiling but does not ship with ArrayFire
           hosted installers/pre-built libraries
-    * Difference of Gaussians (dog)
+    * \ref dog() -  Difference of Gaussians
 
 * Image Processing Functions
-    * RGB <->YCbCr color space conversion (ycbcr2rgb, rgb2ycbcr)
-    * Wrap and Unwrap (wrap, unwrap)
-    * Summed Area Tables (sat)
-    * Load and Save images to/from memory (loadImageMem, saveImageMem)
-        * Add imageFormat (af_image_format) enum
-
-* Utility
-    * Allow users to set print precision (print, af_print_array_gen)
-    * Stream arrays to binary files (saveArray, readArray)
-    * toString function returns the array and data as a string
+    * \ref ycbcr2rgb() and \ref rgb2ycbcr() - RGB <->YCbCr color space conversion
+    * \ref wrap() and \ref unwrap() Wrap and Unwrap
+    * \ref sat() - Summed Area Tables
+    * \ref loadImageMem() and \ref saveImageMem() - Load and Save images to/from memory
+        * \ref af_image_format - Added imageFormat (af_image_format) enum
 
 * Array & Data Handling
-    * Copy (copy)
-    * Lock and Unlock (array::lock, array::unlock)
-    * Select and Replace (select, replace)
+    * \ref copy() - Copy
+    * array::lock() and array::unlock() - Lock and Unlock
+    * \ref select() and \ref replace() - Select and Replace
     * Get array reference count (af_get_data_ref_count)
 
+* Signal Processing
+    * \ref fftInPlace() - 1D in place FFT
+    * \ref fft2InPlace() - 2D in place FFT
+    * \ref fft3InPlace() - 3D in place FFT
+    * \ref ifftInPlace() - 1D in place Inverse FFT
+    * \ref ifft2InPlace() - 2D in place Inverse FFT
+    * \ref ifft3InPlace() - 3D in place Inverse FFT
+    * \ref fftR2C() - Real to complex FFT
+    * \ref fftC2R() - Complex to Real FFT
+
+* Linear Algebra
+    * \ref svd() and \ref svdInPlace() - Singular Value Decomposition
+
 * Other operations
-    * SVD Decomposition (svd)
-    * FFT
-        * Support for in place FFT
-    * Sigmoid (sigmoid)
+    * \ref sigmoid() - Sigmoid
     * Sum (with option to replace NaN values)
     * Product (with option to replace NaN values)
 
 * Graphics
-    * Window resizing using Forge API (Window::setSize)
+    * Window::setSize() - Window resizing using Forge API
+
+* Utility
+    * Allow users to set print precision (print, af_print_array_gen)
+    * \ref saveArray() and \ref readArray() - Stream arrays to binary files
+    * \ref toString() - toString function returns the array and data as a string
+
+* CUDA specific functionality
+    * \ref getStream() - Returns default CUDA stream ArrayFire uses for the current device
+    * \ref getNativeId() - Returns native id of the CUDA device
 
 Improvements
 ------------
@@ -60,18 +74,13 @@ Improvements
 * 64-bit integer support
     * For reductions, random, iota, range, diff1, diff2, accum, join, shift
       and tile
-* sum and product
-    * Support for NaN value substitution
 * convolve
     * Support for non-overlapping batched convolutions
 * Complex Arrays
     * Fix binary ops on complex inputs of mixed types
     * Complex type support for exp
-* FFT
-    * Support for r2c and c2r FFT
-    * Support for in place FFT
 * tile
-    * is now a JIT function
+    * Performance improvements by using JIT when possible.
 * Add AF_API_VERSION macro
     * Allows disabling of API to maintain consistency with previous versions
 * Other Performance Improvements
@@ -123,9 +132,14 @@ Distribution Changes
 
 Known Issues
 ------------
-* OpenBlas can cause issues with QR
+* OpenBlas can cause issues with QR factorization in CPU backend
 * FreeImage older than 3.10 can cause issues with loadImageMem and
   saveImageMem
+* OpenCL backend issues on OSX
+    * AMD GPUs not supported because of driver issues
+    * Intel CPUs not supported
+    * Linear algebra functions do not work on Intel GPUs.
+* Stability and correctness issues with open source OpenCL implementations such as Beignet, GalliumCompute.
 
 v3.0.2
 ==============
diff --git a/include/af/cuda.h b/include/af/cuda.h
@@ -18,22 +18,26 @@ extern "C" {
 
 #if AF_API_VERSION >= 31
 /**
-   Get the stream for the CUDA device with \ref id in ArrayFire context
+   Get the stream for the CUDA device with \p id in ArrayFire context
 
-   \param[out] CUDA Stream of device with \ref id in ArrayFire context
-   \param[in] ArrayFire device id
+   \param[out] stream CUDA Stream of device with \p id in ArrayFire context
+   \param[in] id ArrayFire device id
    \returns \ref af_err error code
+
+   \ingroup cuda_mat
  */
 AFAPI af_err afcu_get_stream(cudaStream_t* stream, int id);
 #endif
 
 #if AF_API_VERSION >= 31
 /**
-   Get the native device id of the CUDA device with \ref id in ArrayFire context
+   Get the native device id of the CUDA device with \p id in ArrayFire context
 
-   \param[out] native device id of the CUDA device with \ref id in ArrayFire context
-   \param[in] ArrayFire device id
+   \param[out] nativeid native device id of the CUDA device with \p id in ArrayFire context
+   \param[in] id ArrayFire device id
    \returns \ref af_err error code
+
+   \ingroup cuda_mat
  */
 AFAPI af_err afcu_get_native_id(int* nativeid, int id);
 #endif
@@ -49,9 +53,9 @@ namespace afcu
 
 #if AF_API_VERSION >= 31
 /**
-   Get the stream for the CUDA device with \ref id in ArrayFire context
+   Get the stream for the CUDA device with \p id in ArrayFire context
 
-   \param[in] ArrayFire device id
+   \param[in] id ArrayFire device id
    \returns cuda stream used by CUDA device
 
    \ingroup cuda_mat
@@ -68,9 +72,9 @@ static inline cudaStream_t getStream(int id)
 
 #if AF_API_VERSION >= 31
 /**
-   Get the native device id of the CUDA device with \ref id in ArrayFire context
+   Get the native device id of the CUDA device with \p id in ArrayFire context
 
-   \param[in] ArrayFire device id
+   \param[in] id ArrayFire device id
    \returns cuda native id of device
 
    \ingroup cuda_mat
diff --git a/include/af/data.h b/include/af/data.h
@@ -204,26 +204,16 @@ namespace af
                       const dim_t d3, const dtype ty=f32);
 
     /**
-        \defgroup data_func_setseed setSeed
-        Set the seed for the random number generator
-
-
         \param[in] seed is a 64 bit unsigned integer
 
-        \ingroup data_mat
-        \ingroup arrayfire_func
+        \ingroup data_func_setseed
     */
     AFAPI void setSeed(const uintl seed);
 
     /**
-        \defgroup data_func_getseed getSeed
-        Get the seed for the random number generator
-
-
         \returns seed which is a 64 bit unsigned integer
 
-        \ingroup data_mat
-        \ingroup arrayfire_func
+        \ingroup data_func_getseed
     */
     AFAPI uintl getSeed();
 
@@ -654,26 +644,16 @@ extern "C" {
     AFAPI af_err af_randn(af_array *out, const unsigned ndims, const dim_t * const dims, const af_dtype type);
 
     /**
-        \defgroup data_func_setseed setSeed
-        Set the seed for the random number generator
-
-
         \param[in] seed is a 64 bit unsigned integer
 
-        \ingroup data_mat
-        \ingroup arrayfire_func
+        \ingroup data_func_setseed
     */
     AFAPI af_err af_set_seed(const uintl seed);
 
     /**
-        \defgroup data_func_getseed getSeed
-        Get the seed for the random number generator
-
-
         \param[out] seed which is a 64 bit unsigned integer
 
-        \ingroup data_mat
-        \ingroup arrayfire_func
+        \ingroup data_func_getseed
     */
     AFAPI af_err af_get_seed(uintl *seed);
 
diff --git a/include/af/util.h b/include/af/util.h
@@ -119,37 +119,6 @@ namespace af
 
 #define GET_PRINT_MACRO(_1, _2, NAME, ...) NAME
 
-/**
-    Macro to print an array along with the variable name
-
-    \param[in] exp the array to be printed
-    \param[in] precision (optional) is the number of decimal places to be printed
-
-    \code
-    af::array myarray = randu(3, 3);
-    int myprecision = 2;
-
-    af_print(myarray);                  // Defaults precision to 4 decimal places
-    // A [3 3 1 1]
-    //     0.0010   311.3614     1.6264
-    //    60.3298   497.9737   359.5948
-    //   165.4467   113.7310     5.2294
-
-    af_print(myarray, myprecision);     // Uses myprecision decimal places
-    // A [3 3 1 1]
-    //     0.00   311.36     1.63
-    //    60.33   497.97   359.59
-    //   165.45   113.73     5.23
-
-    af_print(myarray, 6);               // Uses 6 decimal places
-    // A [3 3 1 1]
-    //     0.001029   311.361402     1.626432
-    //    60.329828   497.973728   359.594787
-    //   165.446732   113.730984     5.229350
-    \endcode
-
-    \ingroup print_func_print
-*/
 #define af_print(...) GET_PRINT_MACRO(__VA_ARGS__, AF_PRINT2, AF_PRINT1)(__VA_ARGS__)
 
 #else
@@ -189,7 +158,7 @@ extern "C" {
 #if AF_API_VERSION >= 31
     /**
         \param[out] index is the index location of the array in the file
-        \param[in] key is an expression used as tag/key for the array during \ref readArray
+        \param[in] key is an expression used as tag/key for the array during \ref readArray()
         \param[in] arr is the array to be written
         \param[in] filename is the path to the location on disk
         \param[in] append is used to append to an existing file when true and create or
diff --git a/include/af/vision.h b/include/af/vision.h
@@ -127,7 +127,7 @@ AFAPI void orb(features& feat, array& desc, const array& image, const float fast
 
     \ingroup cv_func_sift
  */
-AFAPI void sift(features& feat, array& desc, const array& in, const unsigned n_layers=3, const float contrast_thr=0.04f, const float edge_thr=10.f, const float init_sigma=1.6f, const bool double_input=true, const float img_scale=0.00390625f, const float feature_ratio=0.05f);
+AFAPI void sift(features& feat, array& desc, const array& in, const unsigned n_layers=3, const float contrast_thr=0.04f, const float edge_thr=10.f, const float init_sigma=1.6f, const bool double_input=true, const float intensity_scale=0.00390625f, const float feature_ratio=0.05f);
 #endif
 
 /**
@@ -365,7 +365,7 @@ extern "C" {
 
         \ingroup cv_func_sift
     */
-    AFAPI af_err af_sift(af_features *feat, af_array *desc, const af_array in, const unsigned n_layers, const float contrast_thr, const float edge_thr, const float init_sigma, const bool double_input, const float img_scale, const float feature_ratio);
+    AFAPI af_err af_sift(af_features *feat, af_array *desc, const af_array in, const unsigned n_layers, const float contrast_thr, const float edge_thr, const float init_sigma, const bool double_input, const float intensity_scale, const float feature_ratio);
 #endif
 
     /**
diff --git a/include/arrayfire.h b/include/arrayfire.h
