← 返回首页
Fix html output errors and warnings with documentation. Document classes by umar456 · Pull Request #2754 · arrayfire/arrayfire · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
Resetting focus
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .css  (1) .dox  (9) .h  (12) .hpp  (1) .htm  (1) .md  (1) .mk  (1) .txt  (1) .xml  (1) All 9 file types selected Viewed files
Conversations
Failed to load comments. Retry
Loading
Jump to
Jump to file
Failed to load files. Retry
Loading
Diff view
Unified
Split
Hide whitespace
Apply and reload
Show whitespace
Diff view
Unified
Split
Hide whitespace
Apply and reload
2 changes: 2 additions & 0 deletions docs/CMakeLists.txt
Show comments View file Edit file Delete file Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@

include(Version)
set(AF_DOCS_CONFIG "${CMAKE_CURRENT_SOURCE_DIR}/doxygen.mk")
set(AF_DOCS_CONFIG_OUT "${CMAKE_CURRENT_BINARY_DIR}/doxygen.mk.out")

Expand Down
6 changes: 5 additions & 1 deletion docs/arrayfire.css
Show comments View file Edit file Delete file Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ div.support *

#gsearch
{
width : 150px;
width : 20%;
}

.tablist span
Expand All @@ -134,6 +134,10 @@ div.support *
text-shadow : none;
}

#side-nav {
height: 100%
}

#nav-tree
{
background-color : #F7F7F7;
Expand Down
9 changes: 7 additions & 2 deletions docs/details/algorithm.dox
Show comments View file Edit file Delete file Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,8 @@ reduce by key can be seen below:



\defgroup reduce_func_all_true alltrue
\defgroup reduce_func_all_true allTrue
\brief Test if all values in an array are true

\ingroup reduce_mat

Expand All @@ -196,6 +197,7 @@ Return type is b8 for all input types
\copydoc batch_detail_algo

\defgroup reduce_func_all_true_by_key allTrueByKey
\brief Calculate if all values that share the same consecutive keys are true

\ingroup reduce_mat

Expand Down Expand Up @@ -224,6 +226,7 @@ reduce by key can be seen below:


\defgroup reduce_func_any_true anytrue
\brief Calculate if any values in an array are true

\ingroup reduce_mat

Expand All @@ -233,7 +236,8 @@ Return type is b8 for all input types

\copydoc batch_detail_algo

\defgroup reduce_func_any_true_by_key anyTrueByKey
\defgroup reduce_func_anytrue_by_key anyTrueByKey
\brief Calculate if any values that share the same consecutive keys are true

\ingroup reduce_mat

Expand Down Expand Up @@ -298,6 +302,7 @@ reduce by key can be seen below:


\defgroup scan_func_accum accum
\brief Cumulative sum (inclusive). Also known as a scan

\ingroup scan_mat

Expand Down
10 changes: 6 additions & 4 deletions docs/details/arith.dox
Show comments View file Edit file Delete file Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -118,13 +118,12 @@ Check if input two inputs are not equal


\defgroup arith_func_and and
\brief Logical AND

\ingroup logic_mat

Logical and of two inputs



\defgroup arith_func_or or

\ingroup logic_mat
Expand Down Expand Up @@ -213,17 +212,18 @@ Compute \f$x - n * y\f$ where n is quotient of \f$x / y\f$

\defgroup arith_func_abs abs

\brief Absolute value

\ingroup numeric_mat

Absolute value



\defgroup arith_func_arg arg

\ingroup numeric_mat

Phase of a number in the complex plane
\brief Phase of a number in the complex plane



Expand Down Expand Up @@ -319,6 +319,7 @@ arc sin of input


\defgroup arith_func_acos acos
\brief Inverse cosine.

\ingroup trig_mat

Expand Down Expand Up @@ -373,6 +374,7 @@ asinh of input


\defgroup arith_func_acosh acosh
\brief Inverse hyperbolic cosine

\ingroup hyper_mat

Expand Down
2 changes: 1 addition & 1 deletion docs/details/data.dox
Show comments View file Edit file Delete file Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The array created has the same value at all locations

=======================================================================

\defgroup data_func_pad Padding
\defgroup data_func_pad pad

\brief Pad an array

Expand Down
13 changes: 13 additions & 0 deletions docs/details/features.dox
Show comments View file Edit file Delete file Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
/**
\addtogroup arrayfire_func
@{

\defgroup features_group_features features

\brief Lookup values of an array based on sequences and/or arrays

===============================================================================


@}
*/
14 changes: 7 additions & 7 deletions docs/details/image.dox
Show comments View file Edit file Delete file Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ and red-difference chroma components.
\addtogroup arrayfire_func
@{

\defgroup image_func_colorspace colorspace
\defgroup image_func_colorspace colorSpace
\ingroup colorconv_mat

Colorspace conversion function
Expand Down Expand Up @@ -262,7 +262,7 @@ discussion on it can be found [here](http://en.wikipedia.org/wiki/Sobel_operator

=======================================================================

\defgroup image_func_anisotropic_diffusion AnisotropicDiffusion
\defgroup image_func_anisotropic_diffusion anisotropicDiffusion
\ingroup imageflt_mat

\brief Anisotropic Smoothing Filter
Expand Down Expand Up @@ -753,7 +753,7 @@ Affine transforms can be used for various purposes. \ref af::translate, \ref af:
are specializations of the transform function.


\defgroup transform_func_coordinates transformcoordinates
\defgroup transform_func_coordinates transformCoordinates
\ingroup transform_mat

Transform input coordinates
Expand All @@ -766,7 +766,7 @@ transformed points.

=======================================================================

\defgroup image_func_sat SAT
\defgroup image_func_sat sat
\ingroup imageflt_mat

\brief Summed Area Tables
Expand Down Expand Up @@ -970,7 +970,7 @@ wide range of edges in images. A more in depth discussion on it can be found [he

=======================================================================

\defgroup image_func_iterative_deconv Iterative Deconvolutions
\defgroup image_func_iterative_deconv iterativeDeconv
\ingroup imageflt_mat

Iterative Deconvolution Algorithms
Expand Down Expand Up @@ -1022,7 +1022,7 @@ to be in a fixed range, that should be done by the caller explicitly.

=======================================================================

\defgroup image_func_inverse_deconv Inverse Deconvolution
\defgroup image_func_inverse_deconv inverseDeconv
\ingroup imageflt_mat

Inverse deconvolution is an linear algorithm i.e. they are non-iterative in
Expand Down Expand Up @@ -1072,7 +1072,7 @@ explicitly.

=======================================================================

\defgroup image_func_confidence_cc Confidence Connected Components
\defgroup image_func_confidence_cc confidenceCC
\ingroup connected_comps_mat

\brief Segment image based on similar pixel characteristics
Expand Down
27 changes: 11 additions & 16 deletions docs/details/index.dox
Show comments View file Edit file Delete file Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,18 @@

\brief Lookup values of an array based on sequences and/or arrays

===============================================================================


\defgroup index_func_lookup Lookup
\defgroup index_func_lookup lookup
\ingroup index_mat

\brief Lookup values of an array by indexing with another array.

Will return an array with the values in the \p in array from the locations specified in the \p idx array.
The resulting array contains values corresponding to each of the provided indices.
Locations of the input data are assumed to be in the range [0, n). Indexing outside of this range will result in mirrored wrap-around behavior.
Will return an array with the values in the \p in array from the locations
specified in the \p idx array. The resulting array contains values corresponding
to each of the provided indices. Locations of the input data are assumed to be
in the range [0, n). Indexing outside of this range will result in mirrored
wrap-around behavior.

A simple example of one-dimension indexing can be seen in the following example.

Expand All @@ -26,26 +28,19 @@ Index locations can also be out of bounds.

\snippet test/index.cpp ex_index_lookup_oob

The dimensiong along which to query the indices can also be specified. The resulting array will be of the same size as the input, except for the queried dimension which will match the number of elements in the index array.
The axis along which to query the indices can also be specified. The
resulting array will be of the same size as the input, except for the queried
dimension which will match the number of elements in the index array.

\snippet test/index.cpp ex_index_lookup2d



===============================================================================

\defgroup index_func_assign assign
\ingroup index_mat

\brief Copy and write values in the locations specified by the sequences




\defgroup index_func_util util
\ingroup index_mat

\brief Utility functions to create objects of type \ref af_index_t


@}
*/
23 changes: 7 additions & 16 deletions docs/details/random.dox
Show comments View file Edit file Delete file Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@

/**
\addtogroup arrayfire_func
@{

\defgroup random_mat Random Number Generation

Expand All @@ -13,26 +11,18 @@ Functions to generate and manage random numbers and random number engines

===============================================================================

\defgroup random_engine_class randomEngine

\brief Random Number Engine Generation Class

The \ref af::randomEngine class is used to set the type and seed of random
number generation engine based on \ref af::randomEngineType.

\ingroup random_mat

===============================================================================
\addtogroup arrayfire_func
@{

\defgroup random_engine_func_constructor randomEngine Constructors
\defgroup random_func_random_engine randomEngine

\brief Create random number generator object
\brief Functions to create, modify, use, and destroy randomEngine objects

A \ref af::randomEngine object can be used to generate psuedo random numbers
using various types of random number generation algorithms defined by \ref
af::randomEngineType.

\ingroup random_engine_class
\ingroup random_mat

===============================================================================

Expand Down Expand Up @@ -60,7 +50,7 @@ The data is centered around 0.

===============================================================================

\defgroup random_func_set_type setDefaultRandomEngineType
\defgroup random_func_set_default_engine setDefaultRandomEngineType

\brief Set the default random engine type.

Expand Down Expand Up @@ -99,5 +89,6 @@ Returns the seed for the current default random engine.

\ingroup random_mat


@}
*/
12 changes: 7 additions & 5 deletions docs/details/signal.dox
Show comments View file Edit file Delete file Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ factor is calculated internally based on the input data provided.
\addtogroup arrayfire_func
@{

\defgroup signal_func_convolve N-Dimensional Convolutions
\defgroup signal_func_convolve convolve (Non-separable)
\ingroup convolve_mat

\brief Convolution Integral for any(one through three) dimensional data
Expand Down Expand Up @@ -85,7 +85,7 @@ documentation to find out more.



\defgroup signal_func_convolve_sep Separable 2D Convolution
\defgroup signal_func_convolve_sep convolve (Separable)
\ingroup convolve_mat

\brief Separable Convolution
Expand Down Expand Up @@ -120,7 +120,7 @@ can be decomposed into two vectors shown below.
\f$


\defgroup signal_func_convolve1 1D Convolutions
\defgroup signal_func_convolve1 convolve1
\ingroup convolve_mat

\brief Convolution Integral for one dimensional data
Expand Down Expand Up @@ -148,7 +148,7 @@ non-overlapping batch mode, they should satisfy one of the following conditions.



\defgroup signal_func_convolve2 2D Convolutions
\defgroup signal_func_convolve2 convolve2
\ingroup convolve_mat

\brief Convolution Integral for two dimensional data
Expand Down Expand Up @@ -290,7 +290,7 @@ convolutional neural networks.



\defgroup signal_func_convolve3 3D Convolutions
\defgroup signal_func_convolve3 convolve3
\ingroup convolve_mat

\brief Convolution Integral for three dimensional data
Expand Down Expand Up @@ -373,6 +373,7 @@ respectively, given below are the possible batch operations.

\defgroup signal_func_approx1 approx1
\ingroup approx_mat
\brief Interpolation across a single dimension

Performs interpolation on data along a single dimension.

Expand Down Expand Up @@ -407,6 +408,7 @@ interpolation types.

\defgroup signal_func_approx2 approx2
\ingroup approx_mat
\brief Interpolation along two dimensions

Performs interpolation on data along two dimensions.

Expand Down
2 changes: 1 addition & 1 deletion docs/details/vision.dox
Show comments View file Edit file Delete file Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ input arrays to be at most 2-dimensional.

=======================================================================

\defgroup cv_func_dog DoG
\defgroup cv_func_dog dog
\ingroup featdetect_mat

\brief Difference of Gaussians
Expand Down
Loading
Toggle all file notes Toggle all file annotations

Footer

© 2026 GitHub, Inc.