# FloatListKt

Added in 1.4.0

*** ** * ** ***


```
public final class FloatListKt
```

<br />

*** ** * ** ***

## Summary

| ### Public methods |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/FloatList` | `https://developer.android.com/reference/androidx/collection/FloatListKt#buildFloatList(kotlin.Function1)( @https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/MutableFloatList, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> builderAction )` Builds a new `https://developer.android.com/reference/androidx/collection/FloatList` by populating a `https://developer.android.com/reference/androidx/collection/MutableFloatList` using the given `https://developer.android.com/reference/androidx/collection/package-summary#buildFloatList(kotlin.Function1)`. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/FloatList` | `https://developer.android.com/reference/androidx/collection/FloatListKt#buildFloatList(kotlin.Int,kotlin.Function1)( int initialCapacity, @https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/MutableFloatList, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> builderAction )` Builds a new `https://developer.android.com/reference/androidx/collection/FloatList` by populating a `https://developer.android.com/reference/androidx/collection/MutableFloatList` using the given `https://developer.android.com/reference/androidx/collection/package-summary#buildFloatList(kotlin.Int,kotlin.Function1)`. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/FloatList` | `https://developer.android.com/reference/androidx/collection/FloatListKt#emptyFloatList()()` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/FloatList` | `https://developer.android.com/reference/androidx/collection/FloatListKt#floatListOf()()` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/FloatList` | `https://developer.android.com/reference/androidx/collection/FloatListKt#floatListOf(kotlin.Float)(float element1)` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/FloatList` | `https://developer.android.com/reference/androidx/collection/FloatListKt#floatListOf(kotlin.FloatArray)(float... elements)` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/FloatList` | `https://developer.android.com/reference/androidx/collection/FloatListKt#floatListOf(kotlin.Float,kotlin.Float)(float element1, float element2)` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/FloatList` | `https://developer.android.com/reference/androidx/collection/FloatListKt#floatListOf(kotlin.Float,kotlin.Float,kotlin.Float)(float element1, float element2, float element3)` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/MutableFloatList` | `https://developer.android.com/reference/androidx/collection/FloatListKt#mutableFloatListOf()()` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/MutableFloatList` | `https://developer.android.com/reference/androidx/collection/FloatListKt#mutableFloatListOf(kotlin.Float)(float element1)` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/MutableFloatList` | `https://developer.android.com/reference/androidx/collection/FloatListKt#mutableFloatListOf(kotlin.FloatArray)(float... elements)` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/MutableFloatList` | `https://developer.android.com/reference/androidx/collection/FloatListKt#mutableFloatListOf(kotlin.Float,kotlin.Float)(float element1, float element2)` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/MutableFloatList` | `https://developer.android.com/reference/androidx/collection/FloatListKt#mutableFloatListOf(kotlin.Float,kotlin.Float,kotlin.Float)(float element1, float element2, float element3)` |

## Public methods

### buildFloatList

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/FloatList.kt+function:buildFloatList) Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/collection#1.5.0)

```
public static final @NonNull FloatList buildFloatList(
    @NonNull Function1<@NonNull MutableFloatList, Unit> builderAction
)
```

Builds a new `https://developer.android.com/reference/androidx/collection/FloatList` by populating a `https://developer.android.com/reference/androidx/collection/MutableFloatList` using the given `https://developer.android.com/reference/androidx/collection/package-summary#buildFloatList(kotlin.Function1)`.

The instance passed as a receiver to the `https://developer.android.com/reference/androidx/collection/package-summary#buildFloatList(kotlin.Function1)` is valid only inside that function. Using it outside of the function produces an unspecified behavior.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/MutableFloatList, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> builderAction` | Lambda in which the `https://developer.android.com/reference/androidx/collection/MutableFloatList` can be populated. |

### buildFloatList

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/FloatList.kt+function:buildFloatList) Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/collection#1.5.0)

```
public static final @NonNull FloatList buildFloatList(
    int initialCapacity,
    @NonNull Function1<@NonNull MutableFloatList, Unit> builderAction
)
```

Builds a new `https://developer.android.com/reference/androidx/collection/FloatList` by populating a `https://developer.android.com/reference/androidx/collection/MutableFloatList` using the given `https://developer.android.com/reference/androidx/collection/package-summary#buildFloatList(kotlin.Int,kotlin.Function1)`.

The instance passed as a receiver to the `https://developer.android.com/reference/androidx/collection/package-summary#buildFloatList(kotlin.Int,kotlin.Function1)` is valid only inside that function. Using it outside of the function produces an unspecified behavior.

| Parameters |
|---|---|
| `int initialCapacity` | Hint for the expected number of elements added in the `https://developer.android.com/reference/androidx/collection/package-summary#buildFloatList(kotlin.Int,kotlin.Function1)`. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/MutableFloatList, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> builderAction` | Lambda in which the `https://developer.android.com/reference/androidx/collection/MutableFloatList` can be populated. |

### emptyFloatList

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/FloatList.kt+function:emptyFloatList) Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/collection#1.4.0)

```
public static final @NonNull FloatList emptyFloatList()
```

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/FloatList` | a read-only `https://developer.android.com/reference/androidx/collection/FloatList` with nothing in it. |

### floatListOf

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/FloatList.kt+function:floatListOf) Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/collection#1.4.0)

```
public static final @NonNull FloatList floatListOf()
```

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/FloatList` | a read-only `https://developer.android.com/reference/androidx/collection/FloatList` with nothing in it. |

### floatListOf

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/FloatList.kt+function:floatListOf) Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/collection#1.4.0)

```
public static final @NonNull FloatList floatListOf(float element1)
```

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/FloatList` | a new read-only `https://developer.android.com/reference/androidx/collection/FloatList` with `https://developer.android.com/reference/androidx/collection/package-summary#floatListOf(kotlin.Float)` as the only item in the list. |

### floatListOf

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/FloatList.kt+function:floatListOf) Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/collection#1.4.0)

```
public static final @NonNull FloatList floatListOf(float... elements)
```

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/FloatList` | a new read-only `https://developer.android.com/reference/androidx/collection/FloatList` with `https://developer.android.com/reference/androidx/collection/package-summary#floatListOf(kotlin.FloatArray)` in order. |

### floatListOf

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/FloatList.kt+function:floatListOf) Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/collection#1.4.0)

```
public static final @NonNull FloatList floatListOf(float element1, float element2)
```

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/FloatList` | a new read-only `https://developer.android.com/reference/androidx/collection/FloatList` with 2 elements, `https://developer.android.com/reference/androidx/collection/package-summary#floatListOf(kotlin.Float,kotlin.Float)` and `https://developer.android.com/reference/androidx/collection/package-summary#floatListOf(kotlin.Float,kotlin.Float)`, in order. |

### floatListOf

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/FloatList.kt+function:floatListOf) Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/collection#1.4.0)

```
public static final @NonNull FloatList floatListOf(float element1, float element2, float element3)
```

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/FloatList` | a new read-only `https://developer.android.com/reference/androidx/collection/FloatList` with 3 elements, `https://developer.android.com/reference/androidx/collection/package-summary#floatListOf(kotlin.Float,kotlin.Float,kotlin.Float)`, `https://developer.android.com/reference/androidx/collection/package-summary#floatListOf(kotlin.Float,kotlin.Float,kotlin.Float)`, and `https://developer.android.com/reference/androidx/collection/package-summary#floatListOf(kotlin.Float,kotlin.Float,kotlin.Float)`, in order. |

### mutableFloatListOf

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/FloatList.kt+function:mutableFloatListOf) Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/collection#1.4.0)

```
public static final @NonNull MutableFloatList mutableFloatListOf()
```

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/MutableFloatList` | a new empty `https://developer.android.com/reference/androidx/collection/MutableFloatList` with the default capacity. |

### mutableFloatListOf

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/FloatList.kt+function:mutableFloatListOf) Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/collection#1.4.0)

```
public static final @NonNull MutableFloatList mutableFloatListOf(float element1)
```

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/MutableFloatList` | a new `https://developer.android.com/reference/androidx/collection/MutableFloatList` with `https://developer.android.com/reference/androidx/collection/package-summary#mutableFloatListOf(kotlin.Float)` as the only item in the list. |

### mutableFloatListOf

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/FloatList.kt+function:mutableFloatListOf) Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/collection#1.4.0)

```
public static final @NonNull MutableFloatList mutableFloatListOf(float... elements)
```

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/MutableFloatList` | a new `https://developer.android.com/reference/androidx/collection/MutableFloatList` with the given elements, in order. |

### mutableFloatListOf

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/FloatList.kt+function:mutableFloatListOf) Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/collection#1.4.0)

```
public static final @NonNull MutableFloatList mutableFloatListOf(float element1, float element2)
```

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/MutableFloatList` | a new `https://developer.android.com/reference/androidx/collection/MutableFloatList` with 2 elements, `https://developer.android.com/reference/androidx/collection/package-summary#mutableFloatListOf(kotlin.Float,kotlin.Float)` and `https://developer.android.com/reference/androidx/collection/package-summary#mutableFloatListOf(kotlin.Float,kotlin.Float)`, in order. |

### mutableFloatListOf

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/FloatList.kt+function:mutableFloatListOf) Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/collection#1.4.0)

```
public static final @NonNull MutableFloatList mutableFloatListOf(float element1, float element2, float element3)
```

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/MutableFloatList` | a new `https://developer.android.com/reference/androidx/collection/MutableFloatList` with 3 elements, `https://developer.android.com/reference/androidx/collection/package-summary#mutableFloatListOf(kotlin.Float,kotlin.Float,kotlin.Float)`, `https://developer.android.com/reference/androidx/collection/package-summary#mutableFloatListOf(kotlin.Float,kotlin.Float,kotlin.Float)`, and `https://developer.android.com/reference/androidx/collection/package-summary#mutableFloatListOf(kotlin.Float,kotlin.Float,kotlin.Float)`, in order. |