Skip to main content

Specular differentiation in normed vector spaces and its applications

Project description

Specular Differentiation

PyPI version Python 3.11 License CodeFactor CodeQL Advanced Docs

The Python package specular implements specular differentiation which generalizes classical differentiation. This implementation strictly follows the definitions, notations, and results in [1] and [2].

A specular derivative (the red line) can be understood as the average of the inclination angles of the right and left derivatives. In contrast, a symmetric derivative (the purple line) is the average of the right and left derivatives. Their difference is illustrated as in the following figure.

specular-derivative-animation

Table of Contents

Installation

Requirements

specular-differentiation requires:

  • Python >= 3.11
  • ipython >= 8.12.3
  • matplotlib >= 3.10.8
  • numpy >= 2.4.0
  • pandas >= 2.3.3
  • tqdm >= 4.67.1

User installation

Standard Installation (NumPy backend)

pip install specular-differentiation

Advanced Installation (JAX backend)

pip install "specular-differentiation[jax]"

See the documentation for advanced installation (JAX backend, Pytest).

Quick start

The following simple example calculates the specular derivative of the ReLU function $f(x) = max(0, x)$ at the origin.

import specular

ReLU = lambda x: max(x, 0)
specular.derivative(ReLU, x=0)
# Output: 0.41421356237309515

Applications

Specular differentiation is defined in normed vector spaces, allowing for applications in higher-dimensional Euclidean spaces. The specular package includes the following applications.

Ordinary differential equation

  • Directory: examples/ode/
  • References: [1], [3], [4]

In [1], seven schemes are proposed for solving ODEs numerically:

  • the specular Euler scheme of Type 1~6
  • the specular trigonometric scheme

The following example shows that the specular Euler schemes of Type 5 and 6 yield more accurate numerical solutions than classical schemes: the explicit and implicit Euler schemes and the Crank-Nicolson scheme.

ODE-example

Optimization

  • Directory: examples/optimization/
  • References: [2], [5]

In [2], three methods are proposed for optimizing nonsmooth convex objective functions:

  • the specular gradient (SPEG) method
  • the stochastic specular gradient (S-SPEG) method
  • the hybrid specular gradient (H-SPEG) method

The following example compares the three proposed methods with the classical methods: gradient descent (GD), Adaptive Moment Estimation (Adam), and Broyden-Fletcher-Goldfarb-Shanno (BFGS).

optimization-example

Documentation

Getting Started

API Reference

Examples

LaTeX macro

To use the specular differentiation symbol in your LaTeX document, add the following code to your preamble (before \begin{document}):

% Required packages
\usepackage{graphicx}
\usepackage{bm}

% Definition of Specular Differentiation symbol
\newcommand\sd[1][.5]{\mathbin{\vcenter{\hbox{\scalebox{#1}{\,$\bm{\wedge}$}}}}}

Usage examples

Use the symbol in your document (after \begin{document}):

% A specular derivative in the one-dimensional Euclidean space
$f^{\sd}(x)$

% A specular directional derivative in normed vector spaces
$\partial^{\sd}_v f(x)$

Citing specular-differentiation

To cite this repository:

@software{specular2026,
  author  = {Kiyuob Jung},
  title   = {specular-differentiation},
  url     = {https://github.com/kyjung2357/specular-differentiation},
  version = {0.13.0},
  year    = {2026},
  doi     = {TBA},
  note    = {Documentation: https://kyjung2357.github.io/specular-differentiation},
}

References

[1] K. Jung. Nonlinear numerical schemes using specular differentiation for initial value problems of first-order ordinary differential equations. arXiv preprint arXiv:????.?????, TBA.

[2] K. Jung. Specular differentiation in normed vector spaces and its applications to nonsmooth convex optimization. arXiv preprint arXiv:????.?????, TBA.

[3] K. Jung and J. Oh. The specular derivative. arXiv preprint arXiv:2210.06062, 2022.

[4] K. Jung and J. Oh. The wave equation with specular derivatives. arXiv preprint arXiv:2210.06933, 2022.

[5] K. Jung and J. Oh. Nonsmooth convex optimization using the specular gradient method with root-linear convergence. arXiv preprint arXiv:2210.06933, 2024.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

specular_differentiation-0.14.0.tar.gz (23.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

specular_differentiation-0.14.0-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

Details for the file specular_differentiation-0.14.0.tar.gz.

File metadata

File hashes

Hashes for specular_differentiation-0.14.0.tar.gz
Algorithm Hash digest
SHA256 cc8d4409434640424b4b49d805edb8d0373edf37837899986081458e261c68a4
MD5 0aa089531824566b8f1aa787b95ac8c9
BLAKE2b-256 3f5c901fd743b3e64236c8e582f94034ec58f2752cf0c04f53cf12f9946b96c8

See more details on using hashes here.

File details

Details for the file specular_differentiation-0.14.0-py3-none-any.whl.

File metadata

File hashes

Hashes for specular_differentiation-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 53bdfa58195576b29a29ecdba366a7770122711695b6e7c80bf8c01276060f26
MD5 4bd7e330e75bc9454fe059b6697a8cfa
BLAKE2b-256 d94647b7b96a00fbfee453759d81d693bcf257dc107bea466e761a295bf89196

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page