---
title: "ClikaRT::nn::Hardshrink"
sidebar_label: "Hardshrink"
description: "Hard shrinkage: zeroes every element within [-lambd, lambd] and keeps the rest."
---

<!-- Generated by tools/doxygen2mdx from Doxygen XML. Do not edit. -->

<span class="api-kind api-kind--class">class</span>

**Header:** `ClikaRT/nn/generated/activation.h`  
**Inherits:** [`ClikaRT::nn::Module`](./Module.md)

Hard shrinkage: zeroes every element within \[-lambd, lambd\] and keeps the rest. The module form of [`ClikaRT::ops::hardshrink`](../ops/hardshrink.md#hardshrink), which documents the full contract (shapes, dtypes, errors); construct once, then call it like a function.

## Member functions

### Hardshrink(HardshrinkOptions) {#Hardshrink}

<div class="api-signature">

`explicit` **`Hardshrink`**([`HardshrinkOptions`](./HardshrinkOptions.md) `options` `=` `{}`)

</div>

Constructs the module from [`options`](./Hardshrink.md#options) (every default when omitted).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/activation.h`, line 849

</div>

### Hardshrink(double) {#Hardshrink-2}

<div class="api-signature">

`explicit` **`Hardshrink`**(`double` `lambd`)

</div>

`Hardshrink(lambd)`: the positional form of `HardshrinkOptions(lambd)`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/activation.h`, line 852

</div>

### forward() {#forward}

<div class="api-signature">

[`Tensor`](../Tensor.md) **`forward`**([`Tensor`](../Tensor.md) `input`) `const`

</div>

[`forward_impl`](./Hardshrink.md#forward), unwrapped: raises [`ClikaRT::Error`](../Error.md) on failure.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/activation.h`, line 863

</div>

### operator()() {#operator-call}

<div class="api-signature">

[`Tensor`](../Tensor.md) **`operator()`**([`Tensor`](../Tensor.md) `input`) `const`

</div>

Same as [`forward`](./Hardshrink.md#forward).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/activation.h`, line 867

</div>

### options() {#options}

<div class="api-signature">

`const` [`HardshrinkOptions`](./HardshrinkOptions.md)`&` **`options`**() `const`

</div>

The settings this module was constructed with.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/activation.h`, line 871

</div>