{"id":17774077,"url":"https://github.com/stdlib-js/math-base-special-heaviside","last_synced_at":"2025-03-15T16:32:44.863Z","repository":{"id":41362784,"uuid":"376891069","full_name":"stdlib-js/math-base-special-heaviside","owner":"stdlib-js","description":"Evaluate the Heaviside function.","archived":false,"fork":false,"pushed_at":"2025-02-03T00:26:23.000Z","size":385,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-27T03:49:08.827Z","etag":null,"topics":["digital-signal-processing","discontinuous","dist","distribution","dsp","heaviside","javascript","math","mathematics","node","node-js","nodejs","ramp","stdlib","step-function","unit-step-function"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2021-06-14T16:38:03.000Z","updated_at":"2025-02-03T00:25:06.000Z","dependencies_parsed_at":"2023-02-17T06:25:18.531Z","dependency_job_id":"5c3818ea-51dc-495c-b45d-982fbeb1db43","html_url":"https://github.com/stdlib-js/math-base-special-heaviside","commit_stats":{"total_commits":53,"total_committers":1,"mean_commits":53.0,"dds":0.0,"last_synced_commit":"eb210506fc4ac507ab23fc19ac85a82cf99a4a06"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fmath-base-special-heaviside","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fmath-base-special-heaviside/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fmath-base-special-heaviside/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fmath-base-special-heaviside/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/math-base-special-heaviside/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243041780,"owners_count":20226524,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["digital-signal-processing","discontinuous","dist","distribution","dsp","heaviside","javascript","math","mathematics","node","node-js","nodejs","ramp","stdlib","step-function","unit-step-function"],"created_at":"2024-10-26T21:49:38.803Z","updated_at":"2025-03-15T16:32:44.856Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2018 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.\u003c/p\u003e\n  \u003cp\u003eThe library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.\u003c/p\u003e\n  \u003cp\u003eWhen you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# Heaviside Function\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Evaluate the [Heaviside function][heaviside-function].\n\n\u003csection class=\"intro\"\u003e\n\nThe [Heaviside function][heaviside-function] is defined as\n\n\u003c!-- \u003cequation class=\"equation\" label=\"eq:heaviside_function\" align=\"center\" raw=\"H(x) = \\begin{cases} 1 \u0026 \\textrm{if}\\ x \\gt 0 \\\\ 0 \u0026 \\textrm{if}\\ x \\lt 0\\end{cases}\" alt=\"Heaviside function.\"\u003e --\u003e\n\n```math\nH(x) = \\begin{cases} 1 \u0026 \\textrm{if}\\ x \\gt 0 \\\\ 0 \u0026 \\textrm{if}\\ x \\lt 0\\end{cases}\n```\n\n\u003c!-- \u003cdiv class=\"equation\" align=\"center\" data-raw-text=\"H(x) = \\begin{cases} 1 \u0026amp; \\textrm{if}\\ x \\gt 0 \\\\ 0 \u0026amp; \\textrm{if}\\ x \\lt 0\\end{cases}\" data-equation=\"eq:heaviside_function\"\u003e\n    \u003cimg src=\"https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@bb29798906e119fcb2af99e94b60407a270c9b32/lib/node_modules/@stdlib/math/base/special/heaviside/docs/img/equation_heaviside_function.svg\" alt=\"Heaviside function.\"\u003e\n    \u003cbr\u003e\n\u003c/div\u003e --\u003e\n\n\u003c!-- \u003c/equation\u003e --\u003e\n\nand is discontinuous at `0`. Depending on the context, the [Heaviside function][heaviside-function] may be defined as a continuous function. To define the [Heaviside function][heaviside-function] such that the function has rotational symmetry,\n\n\u003c!-- \u003cequation class=\"equation\" label=\"eq:heaviside_function_half_maximum\" align=\"center\" raw=\"H(x) = \\begin{cases} x \u0026 \\textrm{if}\\ x \\gt 0 \\\\ \\frac{1}{2} \u0026 \\textrm{if}\\ x = 0 \\\\ 0 \u0026 \\textrm{if}\\ x \\lt 0\\end{cases}\" alt=\"Heaviside function half-maximum.\"\u003e --\u003e\n\n```math\nH(x) = \\begin{cases} x \u0026 \\textrm{if}\\ x \\gt 0 \\\\ \\frac{1}{2} \u0026 \\textrm{if}\\ x = 0 \\\\ 0 \u0026 \\textrm{if}\\ x \\lt 0\\end{cases}\n```\n\n\u003c!-- \u003cdiv class=\"equation\" align=\"center\" data-raw-text=\"H(x) = \\begin{cases} x \u0026amp; \\textrm{if}\\ x \\gt 0 \\\\ \\frac{1}{2} \u0026amp; \\textrm{if}\\ x = 0 \\\\ 0 \u0026amp; \\textrm{if}\\ x \\lt 0\\end{cases}\" data-equation=\"eq:heaviside_function_half_maximum\"\u003e\n    \u003cimg src=\"https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@bb29798906e119fcb2af99e94b60407a270c9b32/lib/node_modules/@stdlib/math/base/special/heaviside/docs/img/equation_heaviside_function_half_maximum.svg\" alt=\"Heaviside function half-maximum.\"\u003e\n    \u003cbr\u003e\n\u003c/div\u003e --\u003e\n\n\u003c!-- \u003c/equation\u003e --\u003e\n\nTo define the [Heaviside function][heaviside-function] as a left-continuous function,\n\n\u003c!-- \u003cequation class=\"equation\" label=\"eq:heaviside_function_left_continuous\" align=\"center\" raw=\"H(x) = \\begin{cases} x \u0026 \\textrm{if}\\ x \\gt 0 \\\\ 0 \u0026 \\textrm{if}\\ x \\leq 0\\end{cases}\" alt=\"Heaviside function left-continuous.\"\u003e --\u003e\n\n```math\nH(x) = \\begin{cases} x \u0026 \\textrm{if}\\ x \\gt 0 \\\\ 0 \u0026 \\textrm{if}\\ x \\leq 0\\end{cases}\n```\n\n\u003c!-- \u003cdiv class=\"equation\" align=\"center\" data-raw-text=\"H(x) = \\begin{cases} x \u0026amp; \\textrm{if}\\ x \\gt 0 \\\\ 0 \u0026amp; \\textrm{if}\\ x \\leq 0\\end{cases}\" data-equation=\"eq:heaviside_function_left_continuous\"\u003e\n    \u003cimg src=\"https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@bb29798906e119fcb2af99e94b60407a270c9b32/lib/node_modules/@stdlib/math/base/special/heaviside/docs/img/equation_heaviside_function_left_continuous.svg\" alt=\"Heaviside function left-continuous.\"\u003e\n    \u003cbr\u003e\n\u003c/div\u003e --\u003e\n\n\u003c!-- \u003c/equation\u003e --\u003e\n\nTo define the [Heaviside function][heaviside-function] as a right-continuous function,\n\n\u003c!-- \u003cequation class=\"equation\" label=\"eq:heaviside_function_right_continuous\" align=\"center\" raw=\"H(x) = \\begin{cases} x \u0026 \\textrm{if}\\ x \\geq 0 \\\\ 0 \u0026 \\textrm{if}\\ x \\lt 0\\end{cases}\" alt=\"Heaviside function right-continuous.\"\u003e --\u003e\n\n```math\nH(x) = \\begin{cases} x \u0026 \\textrm{if}\\ x \\geq 0 \\\\ 0 \u0026 \\textrm{if}\\ x \\lt 0\\end{cases}\n```\n\n\u003c!-- \u003cdiv class=\"equation\" align=\"center\" data-raw-text=\"H(x) = \\begin{cases} x \u0026amp; \\textrm{if}\\ x \\geq 0 \\\\ 0 \u0026amp; \\textrm{if}\\ x \\lt 0\\end{cases}\" data-equation=\"eq:heaviside_function_right_continuous\"\u003e\n    \u003cimg src=\"https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@bb29798906e119fcb2af99e94b60407a270c9b32/lib/node_modules/@stdlib/math/base/special/heaviside/docs/img/equation_heaviside_function_right_continuous.svg\" alt=\"Heaviside function right-continuous.\"\u003e\n    \u003cbr\u003e\n\u003c/div\u003e --\u003e\n\n\u003c!-- \u003c/equation\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/math-base-special-heaviside\n```\n\nAlternatively,\n\n-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar heaviside = require( '@stdlib/math-base-special-heaviside' );\n```\n\n#### heaviside( x\\[, continuity] )\n\nEvaluates the [Heaviside function][heaviside-function].\n\n```javascript\nvar v = heaviside( 3.14 );\n// returns 1.0\n\nv = heaviside( -3.14 );\n// returns 0.0\n\nv = heaviside( NaN );\n// returns NaN\n```\n\nThe `continuity` parameter may be one of the following values:\n\n-   `'half-maximum'`: if `x == 0`, the function returns `0.5`.\n-   `'left-continuous'`: if `x == 0`, the function returns `0.0`.\n-   `'right-continuous'`: if `x == 0`, the function returns `1.0`.\n\nBy default, the function is discontinuous at `0`.\n\n```javascript\nvar v = heaviside( 0.0 );\n// returns NaN\n```\n\nTo define the [Heaviside function][heaviside-function] as a continuous function, set the `continuity` parameter.\n\n```javascript\nvar v = heaviside( 0.0, 'half-maximum' );\n// returns 0.5\n\nv = heaviside( 0.0, 'left-continuous' );\n// returns 0.0\n\nv = heaviside( 0.0, 'right-continuous' );\n// returns 1.0\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar linspace = require( '@stdlib/array-base-linspace' );\nvar heaviside = require( '@stdlib/math-base-special-heaviside' );\n\nvar x = linspace( -10.0, 10.0, 101 );\n\nvar i;\nfor ( i = 0; i \u003c x.length; i++ ) {\n    console.log( 'H(%d) = %d', x[ i ], heaviside( x[ i ] ) );\n}\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n* * *\n\n## See Also\n\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/math-base/special/ramp`][@stdlib/math/base/special/ramp]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eevaluate the ramp function.\u003c/span\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.\n\nFor more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2025. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-heaviside.svg\n[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-heaviside\n\n[test-image]: https://github.com/stdlib-js/math-base-special-heaviside/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/math-base-special-heaviside/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-heaviside/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-heaviside?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/math-base-special-heaviside.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/math-base-special-heaviside/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/math-base-special-heaviside/tree/deno\n[deno-readme]: https://github.com/stdlib-js/math-base-special-heaviside/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/math-base-special-heaviside/tree/umd\n[umd-readme]: https://github.com/stdlib-js/math-base-special-heaviside/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/math-base-special-heaviside/tree/esm\n[esm-readme]: https://github.com/stdlib-js/math-base-special-heaviside/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/math-base-special-heaviside/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-heaviside/main/LICENSE\n\n[heaviside-function]: https://en.wikipedia.org/wiki/Heaviside_step_function\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/math/base/special/ramp]: https://github.com/stdlib-js/math-base-special-ramp\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fmath-base-special-heaviside","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fmath-base-special-heaviside","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fmath-base-special-heaviside/lists"}