summaryrefslogtreecommitdiff
path: root/utils/tuning/libtuning/gradient.py
blob: b643f50277a972d9305edf82f5a3a194d7bdc876 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# SPDX-License-Identifier: GPL-2.0-or-later
#
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# Gradients that can be used to distribute or map numbers

import libtuning as lt

import math
from numbers import Number


# @brief Gradient for how to allocate pixels to sectors
# @description There are no parameters for the gradients as the domain is the
#              number of pixels and the range is the number of sectors, and
#              there is only one curve that has a startpoint and endpoint at
#              (0, 0) and at (#pixels, #sectors). The exception is for curves
#              that *do* have multiple solutions for only two points, such as
#              gaussian, and curves of higher polynomial orders if we had them.
#
# \todo There will probably be a helper in the Gradient class, as I have a
# feeling that all the other curves (besides Linear and Gaussian) can be
# implemented in the same way.
class Gradient(object):
    def __init__(self):
        pass

    # @brief Distribute pixels into sectors (only in one dimension)
    # @param domain Number of pixels
    # @param sectors Number of sectors
    # @return A list of number of pixels in each sector
    def distribute(self, domain: list, sectors: list) -> list:
        raise NotImplementedError

    # @brief Map a number on a curve
    # @param domain Domain of the curve
    # @param rang Range of the curve
    # @param x Input on the domain of the curve
    # @return y from the range of the curve
    def map(self, domain: tuple, rang: tuple, x: Number) -> Number:
        raise NotImplementedError


class Linear(Gradient):
    # @param remainder Mode of handling remainder
    def __init__(self, remainder: lt.Remainder = lt.Remainder.Float):
        self.remainder = remainder

    def distribute(self, domain: list, sectors: list) -> list:
        size = domain / sectors
        rem = domain % sectors

        if rem == 0:
            return [int(size)] * sectors

        size = math.ceil(size)
        rem = domain % size
        output_sectors = [int(size)] * (sectors - 1)

        if self.remainder == lt.Remainder.Float:
            size = domain / sectors
            output_sectors = [size] * sectors
        elif self.remainder == lt.Remainder.DistributeFront:
            output_sectors.append(int(rem))
        elif self.remainder == lt.Remainder.DistributeBack:
            output_sectors.insert(0, int(rem))
        else:
            raise ValueError

        return output_sectors

    def map(self, domain: tuple, rang: tuple, x: Number) -> Number:
        m = (rang[1] - rang[0]) / (domain[1] - domain[0])
        b = rang[0] - m * domain[0]
        return m * x + b
m">/** * \class FileDescriptor * \brief RAII-style wrapper for file descriptors * * The FileDescriptor class provides RAII-style lifetime management of file * descriptors with an efficient mechanism for ownership sharing. At its core, * an internal Descriptor object wraps a file descriptor (expressed as a signed * integer) with an RAII-style interface. The Descriptor is then implicitly * shared with all FileDescriptor instances constructed as copies. * * When constructed from a numerical file descriptor, the FileDescriptor * instance either duplicates or takes over the file descriptor: * * - The FileDescriptor(const int &) constructor duplicates the numerical file * descriptor and wraps the duplicate in a Descriptor. The caller is * responsible for closing the original file descriptor, and the value * returned by fd() will be different from the value passed to the * constructor. * * - The FileDescriptor(int &&) constructor takes over the numerical file * descriptor and wraps it in a Descriptor. The caller shall not touch the * original file descriptor once the function returns, and the value returned * by fd() will be identical to the value passed to the constructor. * * The copy constructor and assignment operator create copies that share the * Descriptor, while the move versions of those methods additionally make the * other FileDescriptor invalid. When the last FileDescriptor that references a * Descriptor is destroyed, the file descriptor is closed. * * The numerical file descriptor is available through the fd() method. All * FileDescriptor instances created as copies of a FileDescriptor will report * the same fd() value. Callers can perform operations on the fd(), but shall * never close it manually. */ /** * \brief Create a FileDescriptor copying a given \a fd * \param[in] fd File descriptor * * Construct a FileDescriptor from a numerical file descriptor by duplicating * the \a fd, and take ownership of the copy. The original \a fd is left * untouched, and the caller is responsible for closing it when appropriate. * The duplicated file descriptor will be closed automatically when all * FileDescriptor instances that reference it are destroyed. * * If the \a fd is negative, the FileDescriptor is constructed as invalid and * the fd() method will return -1. */ FileDescriptor::FileDescriptor(const int &fd) { if (fd < 0) return; fd_ = std::make_shared<Descriptor>(fd, true); if (fd_->fd() < 0) fd_.reset(); } /** * \brief Create a FileDescriptor taking ownership of a given \a fd * \param[in] fd File descriptor * * Construct a FileDescriptor from a numerical file descriptor by taking * ownership of the \a fd. The original \a fd is set to -1 and shall not be * touched by the caller anymore. In particular, the caller shall not close the * original \a fd manually. The duplicated file descriptor will be closed * automatically when all FileDescriptor instances that reference it are * destroyed. * * If the \a fd is negative, the FileDescriptor is constructed as invalid and * the fd() method will return -1. */ FileDescriptor::FileDescriptor(int &&fd) { if (fd < 0) return; fd_ = std::make_shared<Descriptor>(fd, false); /* * The Descriptor constructor can't have failed here, as it took over * the fd without duplicating it. Just set the original fd to -1 to * implement move semantics. */ fd = -1; } /** * \brief Copy constructor, create a FileDescriptor from a copy of \a other * \param[in] other The other FileDescriptor * * Copying a FileDescriptor implicitly shares ownership of the wrapped file * descriptor. The original FileDescriptor is left untouched, and the caller is * responsible for destroying it when appropriate. The wrapped file descriptor * will be closed automatically when all FileDescriptor instances that * reference it are destroyed. */ FileDescriptor::FileDescriptor(const FileDescriptor &other) : fd_(other.fd_) { } /** * \brief Move constructor, create a FileDescriptor by taking over \a other * \param[in] other The other FileDescriptor * * Moving a FileDescriptor moves the reference to the wrapped descriptor owned * by \a other to the new FileDescriptor. The \a other FileDescriptor is * invalidated and its fd() method will return -1. The wrapped file descriptor * will be closed automatically when all FileDescriptor instances that * reference it are destroyed. */ FileDescriptor::FileDescriptor(FileDescriptor &&other) : fd_(std::move(other.fd_)) { } /** * \brief Destroy the FileDescriptor instance * * Destroying a FileDescriptor instance releases its reference to the wrapped * descriptor, if any. When the last instance that references a wrapped * descriptor is destroyed, the file descriptor is automatically closed. */ FileDescriptor::~FileDescriptor() { } /** * \brief Copy assignment operator, replace the wrapped file descriptor with a * copy of \a other * \param[in] other The other FileDescriptor * * Copying a FileDescriptor creates a new reference to the wrapped file * descriptor owner by \a other. If \a other is invalid, *this will also be * invalid. The original FileDescriptor is left untouched, and the caller is * responsible for destroying it when appropriate. The wrapped file descriptor * will be closed automatically when all FileDescriptor instances that * reference it are destroyed. * * \return A reference to this FileDescriptor */ FileDescriptor &FileDescriptor::operator=(const FileDescriptor &other) { fd_ = other.fd_; return *this; } /** * \brief Move assignment operator, replace the wrapped file descriptor by * taking over \a other * \param[in] other The other FileDescriptor * * Moving a FileDescriptor moves the reference to the wrapped descriptor owned * by \a other to the new FileDescriptor. If \a other is invalid, *this will * also be invalid. The \a other FileDescriptor is invalidated and its fd() * method will return -1. The wrapped file descriptor will be closed * automatically when all FileDescriptor instances that reference it are * destroyed. * * \return A reference to this FileDescriptor */ FileDescriptor &FileDescriptor::operator=(FileDescriptor &&other) { fd_ = std::move(other.fd_); return *this; } /** * \fn FileDescriptor::isValid() * \brief Check if the FileDescriptor instance is valid * \return True if the FileDescriptor is valid, false otherwise */ /** * \fn FileDescriptor::fd() * \brief Retrieve the numerical file descriptor * \return The numerical file descriptor, which may be -1 if the FileDescriptor * instance is invalid */ /** * \brief Duplicate a FileDescriptor * * Duplicating a FileDescriptor creates a duplicate of the wrapped file * descriptor and returns a new FileDescriptor instance that wraps the * duplicate. The fd() method of the original and duplicate instances will * return different values. The duplicate instance will not be affected by * destruction of the original instance or its copies. * * \return A new FileDescriptor instance wrapping a duplicate of the original * file descriptor */ FileDescriptor FileDescriptor::dup() const { return FileDescriptor(fd()); } FileDescriptor::Descriptor::Descriptor(int fd, bool duplicate) { if (!duplicate) { fd_ = fd; return; } /* Failing to dup() a fd should not happen and is fatal. */ fd_ = ::dup(fd); if (fd_ == -1) { int ret = -errno; LOG(FileDescriptor, Fatal) << "Failed to dup() fd: " << strerror(-ret); } } FileDescriptor::Descriptor::~Descriptor() { if (fd_ != -1) close(fd_); } } /* namespace libcamera */