clamping_layer.h

Go to the documentation of this file.

// SPDX-License-Identifier: AGPL-3.0-only
// Copyright (C) 2026 Artificial Intelligence Techniques, S.L. and Roberto López González
 
#pragma once
 
#include "opennn/network/layers/layer.h"
#include "opennn/network/operators/operator.h"
 
namespace opennn
{
 
void apply_clamping(const TensorView&, const TensorView&, const TensorView&, TensorView&);
 
struct ClampingOperator : Operator
{
    enum class Method { NoClamping, Clamping };
 
    Method method = Method::Clamping;
 
    TensorView lower;
    TensorView upper;
 
    void forward_propagate(ForwardPropagation&, size_t, ForwardPropagationMode) override;
};
 
class Clamping final : public Layer
{
public:
 
    using ClampingMethod = ClampingOperator::Method;
 
    Clamping(const Shape& = {0},
             ClampingMethod = ClampingMethod::Clamping,
             const string& = "clamping_layer");
 
    Shape get_input_shape() const noexcept override { return output_shape; }
    Shape get_output_shape() const noexcept override { return output_shape; }
 
    const ClampingMethod& get_clamping_method() const noexcept { return clamping.method; }
 
    VectorR get_lower_bounds() const { return Map<const VectorR>(lower_bounds.data(), ssize(lower_bounds)); }
    VectorR get_upper_bounds() const { return Map<const VectorR>(upper_bounds.data(), ssize(upper_bounds)); }
 
    void set(const Shape& = {0},
             ClampingMethod = ClampingMethod::Clamping,
             const string& = "clamping_layer");
 
    bool accepts_input_rank(Index rank) const override { return is_one_of(rank, 1, 2, 3); }
    bool allows_successors() const noexcept override { return false; }
 
    void apply_input_shape(const Shape&) override;
 
    void set_clamping_method(const ClampingMethod&);
    void set_clamping_method(const string&);
 
    void set_lower_bound(Index, float);
 
    void set_upper_bound(Index, float);
 
    float* link_states(float*, Device) override;
 
    void read_JSON_body(const Json*) override;
    void write_JSON_body(JsonWriter&) const override;
 
    string write_expression(const vector<string>&,
                            const vector<string>&) const override;
 
private:
 
    Shape output_shape;
 
    vector<float> lower_bounds;
    vector<float> upper_bounds;
 
    Buffer op_storage;
    bool   op_storage_dirty = true;
 
    ClampingOperator clamping;
 
    void refresh_op_storage(Device);
 
    static const EnumMap<ClampingMethod>& clamping_method_map();
};
 
}