Skip to content

Fix bitnot docs #3076

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
9prady9 merged 4 commits into from
Jan 11, 2021
Merged

Fix bitnot docs #3076

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
206538e
Fix bitnot documentation
9prady9 Jan 8, 2021
8ad8f87
Escape \ and < characters for doxygen in a path
9prady9 Jan 8, 2021
eec30eb
Update documentation install page with package manager instructions
9prady9 Jan 9, 2021
3e1757f
Update README with package manager install instructions
9prady9 Jan 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ on Windows, Mac, and Linux.

You can install the ArrayFire library from one of the following ways:

### Package Managers

This approach is currently only supported for Ubuntu 18.04 and 20.04. Please
go through [our GitHub wiki page][1] for the detailed instructions.

#### Official installers

Execute one of our [official binary installers](https://arrayfire.com/download)
Expand Down Expand Up @@ -163,3 +168,5 @@ The literal mark “ArrayFire” and ArrayFire logos are trademarks of
AccelerEyes LLC DBA ArrayFire.
If you wish to use either of these marks in your own project, please consult
[ArrayFire's Trademark Policy](http://arrayfire.com/trademark-policy/)

[1]: https://github.com/arrayfire/arrayfire/wiki/Install-ArrayFire-From-Linux-Package-Managers
8 changes: 8 additions & 0 deletions docs/details/arith.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,14 @@ Logical not of an input
Negative of an input


\defgroup arith_func_bitnot bitnot

\ingroup logic_mat

Bitwise not on the input

\copydoc arith_int_only


\defgroup arith_func_bitand bitand

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/configuring_arrayfire_environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,4 +261,4 @@ The default path is determined in the following order:
2. /tmp/arrayfire
Windows:
1. ArrayFire application Temp folder(Usually
C:\Users\<user_name>\AppData\Local\Temp\ArrayFire)
C:\\Users\\\<user_name\>\\AppData\\Local\\Temp\\ArrayFire)
14 changes: 11 additions & 3 deletions docs/pages/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,17 @@ For more information on using ArrayFire on Windows, visit the following

## <a name="Linux"></a> Linux

Once you have downloaded the ArrayFire installer, execute the installer from the
terminal as shown below. Set the `--prefix` argument to the directory you would
like to install ArrayFire to - we recommend `/opt`.
There are two ways to install ArrayFire on Linux.
1. Package Manager
2. Using ArrayFire Linux Installer

As of today, approach (1) is only supported for Ubuntu 18.04 and 20.04. Please go
through [our GitHub wiki page](https://github.com/arrayfire/arrayfire/wiki/Install-ArrayFire-From-Linux-Package-Managers)
for the detailed instructions.

For approach (2), once you have downloaded the ArrayFire installer, execute the
installer from the terminal as shown below. Set the `--prefix` argument to the
directory you would like to install ArrayFire to - we recommend `/opt`.

./Arrayfire_*_Linux_x86_64.sh --include-subdir --prefix=/opt

Expand Down