-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmod.d.ts
113 lines (106 loc) · 2.87 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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/*
* @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 { Slice } from '@stdlib/types/slice';
/**
* Returns the number of elements in a normalized slice.
*
* @param slice - input slice
* @returns number of elements
*
* @example
* var Slice = require( '@stdlib/slice-ctor' );
* var normalizeSlice = require( '@stdlib/slice-base-normalize-slice' );
*
* var s = new Slice( 2, null, 1 );
* // returns <Slice>
*
* var v = sliceLength( normalizeSlice( s, 10, false ) );
* // returns 8
*
* v = sliceLength( normalizeSlice( s, 11, false ) );
* // returns 9
*
* v = sliceLength( normalizeSlice( s, 5, false ) );
* // returns 3
*
* @example
* var Slice = require( '@stdlib/slice-ctor' );
* var normalizeSlice = require( '@stdlib/slice-base-normalize-slice' );
*
* var s = new Slice( 2, null, 2 );
* // returns <Slice>
*
* var v = sliceLength( normalizeSlice( s, 10, false ) );
* // returns 4
*
* v = sliceLength( normalizeSlice( s, 11, false ) );
* // returns 5
*
* v = sliceLength( normalizeSlice( s, 5, false ) );
* // returns 2
*
* @example
* var Slice = require( '@stdlib/slice-ctor' );
* var normalizeSlice = require( '@stdlib/slice-base-normalize-slice' );
*
* var s = new Slice( -1, null, -2 );
*
* var v = sliceLength( normalizeSlice( s, 10, false ) );
* // returns 5
*
* v = sliceLength( normalizeSlice( s, 11, false ) );
* // returns 6
*
* v = sliceLength( normalizeSlice( s, 5, false ) );
* // returns 3
*
* @example
* var Slice = require( '@stdlib/slice-ctor' );
* var normalizeSlice = require( '@stdlib/slice-base-normalize-slice' );
*
* var s = new Slice( 3, 5, -1 );
*
* var v = sliceLength( normalizeSlice( s, 10, false ) );
* // returns 0
*
* v = sliceLength( normalizeSlice( s, 11, false ) );
* // returns 0
*
* v = sliceLength( normalizeSlice( s, 5, false ) );
* // returns 0
*
* @example
* var Slice = require( '@stdlib/slice-ctor' );
* var normalizeSlice = require( '@stdlib/slice-base-normalize-slice' );
*
* var s = new Slice( 5, 3, 1 );
*
* var v = sliceLength( normalizeSlice( s, 10, false ) );
* // returns 0
*
* v = sliceLength( normalizeSlice( s, 11, false ) );
* // returns 0
*
* v = sliceLength( normalizeSlice( s, 5, false ) );
* // returns 0
*/
declare function sliceLength( slice: Slice ): number;
// EXPORTS //
export = sliceLength;