-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmod.d.ts
84 lines (77 loc) · 2.54 KB
/
mod.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/*
* @license Apache-2.0
*
* Copyright (c) 2023 The Stdlib Authors.
*
* Licensed 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.
*/
// TypeScript Version: 4.1
/// <reference types="https://cdn.jsdelivr.net/gh/stdlib-js/types@main/index.d.ts"/>
import { MultiSlice } from '@stdlib/types/slice';
/**
* Returns the shape of a normalized multi-slice.
*
* @param slice - input multi-slice
* @returns slice shape
*
* @example
* var Slice = require( '@stdlib/slice-ctor' );
* var MultiSlice = require( '@stdlib/slice-multi' );
* var normalizeMultiSlice = require( '@stdlib/slice-base-normalize-multi-slice' );
*
* var s = new MultiSlice( new Slice( 2, null, 1 ), null, 10 );
*
* var v = sliceShape( normalizeMultiSlice( s, [ 10, 5, 20 ], false ) );
* // returns [ 8, 5, 1 ]
*
* v = sliceShape( normalizeMultiSlice( s, [ 11, 3, 12 ], false ) );
* // returns [ 9, 3, 1 ]
*
* v = sliceShape( normalizeMultiSlice( s, [ 5, 10, 15 ], false ) );
* // returns [ 3, 10, 1 ]
*
* @example
* var Slice = require( '@stdlib/slice-ctor' );
* var MultiSlice = require( '@stdlib/slice-multi' );
* var normalizeMultiSlice = require( '@stdlib/slice-base-normalize-multi-slice' );
*
* var s = new MultiSlice( null, new Slice( -1, 3, -2 ) );
*
* var v = sliceShape( normalizeMultiSlice( s, [ 10, 5 ], false ) );
* // returns [ 10, 1 ]
*
* v = sliceShape( normalizeMultiSlice( s, [ 11, 10 ], false ) );
* // returns [ 11, 3 ]
*
* v = sliceShape( normalizeMultiSlice( s, [ 5, 15 ], false ) );
* // returns [ 5, 6 ]
*
* @example
* var Slice = require( '@stdlib/slice-ctor' );
* var MultiSlice = require( '@stdlib/slice-multi' );
* var normalizeMultiSlice = require( '@stdlib/slice-base-normalize-multi-slice' );
*
* var s = new MultiSlice( 1, new Slice( 0, 0, 1 ) );
*
* var v = sliceShape( normalizeMultiSlice( s, [ 10, 5 ], false ) );
* // returns [ 1, 0 ]
*
* v = sliceShape( normalizeMultiSlice( s, [ 11, 10 ], false ) );
* // returns [ 1, 0 ]
*
* v = sliceShape( normalizeMultiSlice( s, [ 5, 15 ], false ) );
* // returns [ 1, 0 ]
*/
declare function sliceShape( slice: MultiSlice ): Array<number>;
// EXPORTS //
export = sliceShape;