UNPKG

1.35 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2018 Google LLC. All Rights Reserved.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 * =============================================================================
16 */
17/// <amd-module name="@tensorflow/tfjs-core/dist/ops/scalar" />
18import { Scalar } from '../tensor';
19import { DataType } from '../types';
20/**
21 * Creates rank-0 `tf.Tensor` (scalar) with the provided value and dtype.
22 *
23 * The same functionality can be achieved with `tf.tensor`, but in general
24 * we recommend using `tf.scalar` as it makes the code more readable.
25 *
26 * ```js
27 * tf.scalar(3.14).print();
28 * ```
29 *
30 * @param value The value of the scalar.
31 * @param dtype The data type.
32 *
33 * @doc {heading: 'Tensors', subheading: 'Creation'}
34 */
35export declare function scalar(value: number | boolean | string | Uint8Array, dtype?: DataType): Scalar;