-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
151 lines (125 loc) · 2.76 KB
/
index.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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*
* @license Apache-2.0
*
* Copyright (c) 2020 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: 2.0
/**
* Data point.
*/
interface Observation {
/**
* Observation number.
*/
obs: number;
/**
* Town name.
*/
town: string;
/**
* Town identifier.
*/
town_id: number;
/**
* Tract identifier.
*/
tract: number;
/**
* Longitude.
*/
lon: number;
/**
* Latitude.
*/
lat: number;
/**
* Median value of owner-occupied homes in $1000's.
*/
medv: number;
/**
* Corrected median value of owner-occupied homes in $1000's.
*/
cmedv: number;
/**
* Per capita crime rate by town.
*/
crim: number;
/**
* Proportion of residential land zoned for lots over 25,000 square feet.
*/
zn: number;
/**
* Proportion of non-retail business acres per town.
*/
indus: number;
/**
* Charles River dummy variable (1 if tract bounds river; 0 otherwise).
*/
chas: number;
/**
* Nitric oxides concentration (parts per 10 million).
*/
nox: number;
/**
* Average number of rooms per dwelling.
*/
rm: number;
/**
* Proportion of owner-occupied units built prior to 1940.
*/
age: number;
/**
* Weighted distances to five Boston employment centers.
*/
dis: number;
/**
* Index of accessibility to radial highways.
*/
rad: number;
/**
* Full-value property-tax rate per $10,000.
*/
tax: number;
/**
* Pupil-teacher ratio by town.
*/
ptratio: number;
/**
* 1000(Bk-0.63)^2 where Bk is the proportion of blacks by town.
*/
b: number;
/**
* Percent lower status of the population.
*/
lstat: number;
}
/**
* Returns a (corrected) dataset derived from information collected by the US Census Service concerning housing in Boston, Massachusetts (1978).
*
* ## Notes
*
* - This function synchronously reads data from disk for each invocation. Such behavior is intentional and so is the avoidance of `require`. We assume that invocations are infrequent, and we want to avoid the `require` cache. This means that we allow data to be garbage collected and a user is responsible for explicitly caching data.
*
*
* @throws unable to read data
* @returns housing data
*
* @example
* var data = dataset();
* // returns [ {...}, {...}, ... ]
*/
declare function dataset(): Array<Observation>;
// EXPORTS //
export = dataset;