# `Frequency`

How often something happens per second: `50Hz` or `2.4GHz`.

Use it for mains, radio and processor speeds. For a heartbeat, use [`HeartRate`](/docs/types/type-heart-rate.md). For video, use [`FrameRate`](/docs/types/type-frame-rate.md).

## Shape

One value, with no fields to fill in. As text it reads `2400000000 Hz`.

## Example

```jadpo
Frequency(50Hz)
```

`text.parse(raw, as: Frequency)` reads one from text that comes from outside. Text that isn't one at all fails `malformed`, such as `5`, `1.2.3` or `five`.

These operations give one: `units.of` and `units.sum`.

## Good to know

- It is held in hertz to 3 places.
- `==` tells you whether two are the same, and `<` and `list.sort_by` compare and sort them.

## In JSON

An object of its parts, in a request, a response or `json.write`:

```json
{"value":"50","unit":"Hz"}
{"value":"440","unit":"Hz"}
{"value":"2400000000","unit":"Hz"}
```

## Details

<details>
<summary>Text form, storage, how it is shown, and operations</summary>

`Frequency` is in the group Physical quantities, and has been in Jadpo since 0.1.0.

### Text form

`text.from` writes one standard text form, the same form `text.parse` reads back: `50 Hz`, `440 Hz` and `2400000000 Hz`.

### How it is stored

It is stored in one column named for the field, of type `numeric(38, 3)`, holding the frequency in hertz (Hz). `440 Hz` is stored as `440`.

### How it is shown to people

`text.format(value, locale:)` shows it to people in their locale. A call may also give `unit:`.

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `50 Hz` | `50 Hz` |
| `440 Hz` | `440 Hz` |
| `2400000000 Hz` | `2,400,000,000 Hz` |

### Operations

- `units.in(value: Quantity, unit: QuantityUnit, scale: Int, rounding: Rounding) -> Decimal`: `value` in `unit`, a unit of its kind, as a `Decimal` of `scale` places rounded by `rounding`: `units.in(5km, LengthUnit.mile, scale: 2, rounding: Rounding.half_even)` is `3.11`.
- `units.of(value: Number, unit: QuantityUnit) -> Quantity`: `value` of `unit`, an `Int` or a `Decimal`, as the quantity of `unit`'s kind, converted exactly to the base unit and rounded half to even to the kind's scale: `units.of(5, LengthUnit.mile)`.
- `units.sum(items: List<Quantity>) -> Quantity`: The items added up, all of one kind; nothing for no items. A `Temperature` or a `SoundLevel` doesn't add to itself, so neither is summed.

It also takes `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. [How every standard type behaves](/docs/every-standard-type-meets-one-contract.md) says how they work.

</details>