Document feedback

Question document fragment

When a question document fragment contains a formula, it is displayed as a space.

Submission type
issue

It's a little complicated...

I'd like to ask someone.

PR

Just a small problem.

I can fix it online!

Please select the submission type

Problem type
Specifications and Common Mistakes

- Specifications and Common Mistakes:

- Misspellings or punctuation mistakes,incorrect formulas, abnormal display.

- Incorrect links, empty cells, or wrong formats.

- Chinese characters in English context.

- Minor inconsistencies between the UI and descriptions.

- Low writing fluency that does not affect understanding.

- Incorrect version numbers, including software package names and version numbers on the UI.

Usability

- Usability:

- Incorrect or missing key steps.

- Missing main function descriptions, keyword explanation, necessary prerequisites, or precautions.

- Ambiguous descriptions, unclear reference, or contradictory context.

- Unclear logic, such as missing classifications, items, and steps.

Correctness

- Correctness:

- Technical principles, function descriptions, supported platforms, parameter types, or exceptions inconsistent with that of software implementation.

- Incorrect schematic or architecture diagrams.

- Incorrect commands or command parameters.

- Incorrect code.

- Commands inconsistent with the functions.

- Wrong screenshots.

- Sample code running error, or running results inconsistent with the expectation.

Risk Warnings

- Risk Warnings:

- Lack of risk warnings for operations that may damage the system or important data.

Content Compliance

- Content Compliance:

- Contents that may violate applicable laws and regulations or geo-cultural context-sensitive words and expressions.

- Copyright infringement.

Please select the type of question

Problem description

Describe the bug so that we can quickly locate the problem.

sponge.function.calc_distance

View Source On Gitee
sponge.function.calc_distance(position_a: Tensor, position_b: Tensor, pbc_box: Tensor = None, keepdims: bool = False)[source]

Compute distance between position A and B.

Parameters
  • position_a (Tensor) – Tensor of shape (...,D). Data type is float. Position coordinate of point A.

  • position_b (Tensor) – Tensor of shape (...,D). Data type is float. Position coordinate of point B.

  • pbc_box (Tensor) – Tensor of shape (D) or (B,D). Data type is float. Size of PBC box L

  • keepdims (bool) – If this is set to True , the last axis will be left in the result as dimensions with size one. Default: False .

Returns

distance (Tensor), a tensor of shape (...) or (...,1) . Data type is float.

Supported Platforms:

Ascend GPU

Examples

>>> import mindspore as ms
>>> from mindspore import Tensor
>>> from sponge.function import calc_distance
>>> tensor_a = Tensor([[1, 2, 3], [4, 5, 6]], ms.float32)
>>> tensor_b = Tensor([[1, 2, 4], [6, 8, 10]], ms.float32)
>>> calc_distance(tensor_a, tensor_b)
Tensor(shape=[2], dtype=Float32, value= [ 1.00000000e+00,  5.38516474e+00])
>>> pbc_box = Tensor([[3, 3, 3]], ms.float32)
>>> calc_distance(tensor_a, tensor_b, pbc_box)
>>> Tensor(shape=[2], dtype=Float32, value= [ 1.00000000e+00,  1.41421354e+00])