| <!--- Licensed to the Apache Software Foundation (ASF) under one --> |
| <!--- or more contributor license agreements. See the NOTICE file --> |
| <!--- distributed with this work for additional information --> |
| <!--- regarding copyright ownership. The ASF licenses this file --> |
| <!--- to you under the Apache License, Version 2.0 (the --> |
| <!--- "License"); you may not use this file except in compliance --> |
| <!--- with the License. You may obtain a copy of the License at --> |
| |
| <!--- http://www.apache.org/licenses/LICENSE-2.0 --> |
| |
| <!--- Unless required by applicable law or agreed to in writing, --> |
| <!--- software distributed under the License is distributed on an --> |
| <!--- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --> |
| <!--- KIND, either express or implied. See the License for the --> |
| <!--- specific language governing permissions and limitations --> |
| <!--- under the License. --> |
| |
| # NDArray API |
| |
| ## Arithmetic Operations |
| |
| In the following example `y` can be a `Real` value or another `NDArray` |
| |
| | API | Example | | |
| |-----|----------|----------------------------| |
| | `+` | `x .+ y` | Elementwise summation | |
| | `-` | `x .- y` | Elementwise minus | |
| | `*` | `x .* y` | Elementwise multiplication | |
| | `/` | `x ./ y` | Elementwise division | |
| | `^` | `x .^ y` | Elementwise power | |
| | `%` | `x .% y` | Elementwise modulo | |
| |
| |
| ## Trigonometric Functions |
| |
| | API | Example | | |
| |----------------|------------|-----------------------------| |
| | [`sin`](@ref) | `sin.(x)` | Elementwise sine | |
| | [`cos`](@ref) | `cos.(x)` | Elementwise cosine | |
| | [`tan`](@ref) | `tan.(x)` | Elementwise tangent | |
| | [`asin`](@ref) | `asin.(x)` | Elementwise inverse sine | |
| | [`acos`](@ref) | `acos.(x)` | Elementwise inverse cosine | |
| | [`atan`](@ref) | `atan.(x)` | Elementwise inverse tangent | |
| |
| |
| ## Hyperbolic Functions |
| |
| | API | Example | | |
| |-----------------|-------------|----------------------------------------| |
| | [`sinh`](@ref) | `sinh.(x)` | Elementwise hyperbolic sine | |
| | [`cosh`](@ref) | `cosh.(x)` | Elementwise hyperbolic cosine | |
| | [`tanh`](@ref) | `tanh.(x)` | Elementwise hyperbolic tangent | |
| | [`asinh`](@ref) | `asinh.(x)` | Elementwise inverse hyperbolic sine | |
| | [`acosh`](@ref) | `acosh.(x)` | Elementwise inverse hyperbolic cosine | |
| | [`atanh`](@ref) | `atanh.(x)` | Elementwise inverse hyperbolic tangent | |
| |
| |
| ## Activation Functions |
| |
| | API | Example | | |
| |-----------------------|-------------------|-------------------------| |
| | [`σ`](@ref) | `σ.(x)` | Sigmoid function | |
| | [`sigmoid`](@ref) | `sigmoid.(x)` | Sigmoid function | |
| | [`relu`](@ref) | `relu.(x)` | ReLU function | |
| | [`softmax`](@ref) | `softmax.(x)` | Softmax function | |
| | [`log_softmax`](@ref) | `log_softmax.(x)` | Softmax followed by log | |
| |
| |
| ## Reference |
| |
| ```@autodocs |
| Modules = [MXNet.mx] |
| Pages = ["ndarray.jl"] |
| ``` |
