{"id":25228149,"url":"https://github.com/stdlib-js/lapack-base-zrot","last_synced_at":"2025-04-05T13:40:54.094Z","repository":{"id":273495353,"uuid":"918468401","full_name":"stdlib-js/lapack-base-zrot","owner":"stdlib-js","description":"LAPACK auxiliary routine to apply a plane rotation with real cosine and complex sine.","archived":false,"fork":false,"pushed_at":"2025-03-17T02:35:37.000Z","size":241,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-17T02:42:52.878Z","etag":null,"topics":["algebra","array","blas","complex","complex128","javascript","lapack","linear","math","mathematics","ndarray","node","node-js","nodejs","rotation","stdlib","subroutines","typed","vector","zrot"],"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":"2025-01-18T02:28:29.000Z","updated_at":"2025-03-17T01:53:56.000Z","dependencies_parsed_at":"2025-01-21T09:23:30.132Z","dependency_job_id":"470c754f-718f-4aaf-8b86-2633589e2871","html_url":"https://github.com/stdlib-js/lapack-base-zrot","commit_stats":null,"previous_names":["stdlib-js/lapack-base-zrot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Flapack-base-zrot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Flapack-base-zrot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Flapack-base-zrot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Flapack-base-zrot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/lapack-base-zrot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247345374,"owners_count":20924097,"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":["algebra","array","blas","complex","complex128","javascript","lapack","linear","math","mathematics","ndarray","node","node-js","nodejs","rotation","stdlib","subroutines","typed","vector","zrot"],"created_at":"2025-02-11T09:51:34.729Z","updated_at":"2025-04-05T13:40:54.070Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2025 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# zrot\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 Apply a plane rotation with real cosine and complex sine to a pair of double-precision complex floating-point vectors.\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/lapack-base-zrot\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 zrot = require( '@stdlib/lapack-base-zrot' );\n```\n\n#### zrot( N, zx, strideX, zy, strideY, c, s )\n\nApplies a plane rotation with real cosine and complex sine.\n\n```javascript\nvar Complex128Array = require( '@stdlib/array-complex128' );\nvar Complex128 = require( '@stdlib/complex-float64-ctor' );\nvar real = require( '@stdlib/complex-float64-real' );\nvar imag = require( '@stdlib/complex-float64-imag' );\n\nvar zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );\nvar zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );\nvar s = new Complex128( 0.0, 0.75 );\n\nzrot( zx.length, zx, 1, zy, 1, 1.25, s );\n\nvar z = zy.get( 0 );\n// returns \u003cComplex128\u003e\n\nvar re = real( z );\n// returns ~-1.5\n\nvar im = imag( z );\n// returns ~0.75\n\nz = zx.get( 0 );\n// returns \u003cComplex128\u003e\n\nre = real( z );\n// returns ~1.25\n\nim = imag( z );\n// returns ~2.5\n```\n\nThe function has the following parameters:\n\n-   **N**: number of indexed elements.\n-   **zx**: first input [`Complex128Array`][@stdlib/array/complex128].\n-   **strideX**: index increment for `zx`.\n-   **zy**: second input [`Complex128Array`][@stdlib/array/complex128].\n-   **strideY**: index increment for `zy`.\n\nThe `N` and stride parameters determine how values from `zx` and `zy` are accessed at runtime. For example, to apply a plane rotation to every other element,\n\n```javascript\nvar Complex128Array = require( '@stdlib/array-complex128' );\nvar Complex128 = require( '@stdlib/complex-float64-ctor' );\nvar real = require( '@stdlib/complex-float64-real' );\nvar imag = require( '@stdlib/complex-float64-imag' );\n\nvar zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );\nvar zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );\nvar s = new Complex128( 0.0, 0.75 );\n\nzrot( 2, zx, 2, zy, 2, 1.25, s );\n\nvar z = zy.get( 0 );\n// returns \u003cComplex128\u003e\n\nvar re = real( z );\n// returns ~-1.5\n\nvar im = imag( z );\n// returns ~0.75\n\nz = zx.get( 0 );\n// returns \u003cComplex128\u003e\n\nre = real( z );\n// returns ~1.25\n\nim = imag( z );\n// returns ~2.5\n```\n\nNote that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.\n\n\u003c!-- eslint-disable stdlib/capitalized-comments --\u003e\n\n```javascript\nvar Complex128Array = require( '@stdlib/array-complex128' );\nvar Complex128 = require( '@stdlib/complex-float64-ctor' );\nvar real = require( '@stdlib/complex-float64-real' );\nvar imag = require( '@stdlib/complex-float64-imag' );\n\n// Initial arrays...\nvar zx0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );\nvar zy0 = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );\n\n// Create offset views...\nvar zx1 = new Complex128Array( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 ); // start at 2nd element\nvar zy1 = new Complex128Array( zy0.buffer, zy0.BYTES_PER_ELEMENT*2 ); // start at 3rd element\n\nvar s = new Complex128( 0.0, 0.75 );\n\nzrot( 2, zx1, -2, zy1, 1, 1.25, s );\n\nvar z = zy0.get( 2 );\n// returns \u003cComplex128\u003e\n\nvar re = real( z );\n// returns ~-6\n\nvar im = imag( z );\n// returns ~5.25\n\nz = zx0.get( 3 );\n// returns \u003cComplex128\u003e\n\nre = real( z );\n// returns ~8.75\n\nim = imag( z );\n// returns ~10\n```\n\n#### zrot.ndarray( N, zx, strideX, offsetX, zy, strideY, offsetY, c, s )\n\nApplies a plane rotation with real cosine and complex sine using alternative indexing semantics.\n\n```javascript\nvar Complex128Array = require( '@stdlib/array-complex128' );\nvar Complex128 = require( '@stdlib/complex-float64-ctor' );\nvar real = require( '@stdlib/complex-float64-real' );\nvar imag = require( '@stdlib/complex-float64-imag' );\n\nvar zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );\nvar zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );\nvar s = new Complex128( 0.0, 0.75 );\n\nzrot.ndarray( zx.length, zx, 1, 0, zy, 1, 0, 1.25, s );\n\nvar z = zy.get( 0 );\n// returns \u003cComplex128\u003e\n\nvar re = real( z );\n// returns ~-1.5\n\nvar im = imag( z );\n// returns ~0.75\n\nz = zx.get( 0 );\n// returns \u003cComplex128\u003e\n\nre = real( z );\n// returns ~1.25\n\nim = imag( z );\n// returns ~2.5\n```\n\nThe function has the following additional parameters:\n\n-   **offsetX**: starting index for `zx`.\n-   **offsetY**: starting index for `zy`.\n\nWhile [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to apply a plane rotation to every other element starting from the second element,\n\n```javascript\nvar Complex128Array = require( '@stdlib/array-complex128' );\nvar Complex128 = require( '@stdlib/complex-float64-ctor' );\nvar real = require( '@stdlib/complex-float64-real' );\nvar imag = require( '@stdlib/complex-float64-imag' );\n\nvar zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );\nvar zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );\nvar s = new Complex128( 0.0, 0.75 );\n\nzrot.ndarray( 2, zx, 2, 1, zy, 2, 1, 1.25, s );\n\nvar z = zy.get( 3 );\n// returns \u003cComplex128\u003e\n\nvar re = real( z );\n// returns ~-6.0\n\nvar im = imag( z );\n// returns ~5.25\n\nz = zx.get( 1 );\n// returns \u003cComplex128\u003e\n\nre = real( z );\n// returns ~3.75\n\nim = imag( z );\n// returns ~5.0\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   If `N \u003c= 0`, both functions leave `zx` and `zy` unchanged.\n-   `zrot()` corresponds to the [LAPACK][lapack] routine [`zrot`][zrot].\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar discreteUniform = require( '@stdlib/random-base-discrete-uniform' );\nvar filledarrayBy = require( '@stdlib/array-filled-by' );\nvar Complex128 = require( '@stdlib/complex-float64-ctor' );\nvar zcopy = require( '@stdlib/blas-base-zcopy' );\nvar zeros = require( '@stdlib/array-zeros' );\nvar logEach = require( '@stdlib/console-log-each' );\nvar zrot = require( '@stdlib/lapack-base-zrot' );\n\nfunction rand() {\n    return new Complex128( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) );\n}\n\n// Generate random input arrays:\nvar zx = filledarrayBy( 10, 'complex128', rand );\nvar zxc = zcopy( zx.length, zx, 1, zeros( zx.length, 'complex128' ), 1 );\n\nvar zy = filledarrayBy( 10, 'complex128', rand );\nvar zyc = zcopy( zy.length, zy, 1, zeros( zy.length, 'complex128' ), 1 );\n\nvar s = new Complex128( 0.0, 0.75 );\n\n// Apply a plane rotation:\nzrot( zx.length, zx, 1, zy, 1, 1.25, s );\n\n// Print the results:\nlogEach( '(%s,%s) =\u003e (%s,%s)', zxc, zyc, zx, zy );\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\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/lapack-base-zrot.svg\n[npm-url]: https://npmjs.org/package/@stdlib/lapack-base-zrot\n\n[test-image]: https://github.com/stdlib-js/lapack-base-zrot/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/lapack-base-zrot/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/lapack-base-zrot/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/lapack-base-zrot?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/lapack-base-zrot.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/lapack-base-zrot/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/lapack-base-zrot/tree/deno\n[deno-readme]: https://github.com/stdlib-js/lapack-base-zrot/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/lapack-base-zrot/tree/umd\n[umd-readme]: https://github.com/stdlib-js/lapack-base-zrot/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/lapack-base-zrot/tree/esm\n[esm-readme]: https://github.com/stdlib-js/lapack-base-zrot/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/lapack-base-zrot/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/lapack-base-zrot/main/LICENSE\n\n[lapack]: http://www.netlib.org/lapack\n\n[zrot]: https://netlib.org/lapack/explore-html/d1/d45/group__rot_gaac9d54e7408105ad6f4c810902e75b7a.html#gaac9d54e7408105ad6f4c810902e75b7a\n\n[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\n\n[@stdlib/array/complex128]: https://github.com/stdlib-js/array-complex128\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%2Flapack-base-zrot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Flapack-base-zrot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Flapack-base-zrot/lists"}