Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

ndarray-gradient

Package Overview
Dependencies
Maintainers
6
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ndarray-gradient

Finds the gradient of an ndarray using finite differences

  • 1.0.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
21K
increased by14.84%
Maintainers
6
Weekly downloads
 
Created
Source

ndarray-gradient

Computes the gradient of an ndarray using a 2-point central finite difference template.

Example

var pack = require('ndarray-pack')
var pool = require('ndarray-scratch')
var grad = require('ndarray-gradient')
var show = require('ndarray-show')

var X = pack([[0, 0, 0],
              [0, 1, 0],
              [0, 0, 0]])

//Compute gradient of X
var dX = grad(pool.zero([3,3,2]), X)

console.log('grad(X) = \n', show(dX))

Output:

grad(X) =
   0.000    0.000    0.000
  -0.500    0.000    0.500
   0.000    0.000    0.000

   0.000   -0.500    0.000
   0.000    0.000    0.000
   0.000    0.500    0.000

Install

npm install ndarray-gradient

API

require('ndarray-gradient')(dst, src[, bc])

Computes the gradient of src storing the result into dst.

  • dst is an array of gradient values. The shape of dst must be the shape of src with one additional dimension for the components of the gradient

  • src is the array to differentiate

  • bc is an array of boundary conditions. The boundary conditions are encoded as string values and must be one of the following values:

    • 'clamp' (Default) clamp boundary edges to boundary
    • 'mirror' mirror values across the boundary
    • 'wrap' wrap values across boundary

Returns dst

Credits

(c) 2014 Mikola Lysenko. MIT License

Keywords

FAQs

Package last updated on 03 Sep 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc