eseries.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2020 <[email protected]>
 * Copyright (C) 2020-2022 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#include <array>
#include <vector>
#include <string>
#include <cstdint>
 
// List of normalized values between 1 and 10
// The terminal 0.0 value is a end of list value
// Note also due to calculation time the E24 serie is the biggest usable.
#define E24_VALUES 1.0, 1.1, 1.2, 1.3, 1.5, 1.6, 1.8, 2.0, 2.2, 2.4, 2.7, 3.0,\
 3.3, 3.6, 3.9, 4.3, 4.7, 5.1, 5.6, 6.2, 6.8, 7.5, 8.2, 9.1, 0.0
 
#define E12_VALUES 1.0, 1.2, 1.5, 1.8, 2.2, 2.7, 3.3, 3.9, 4.7, 5.6, 6.8, 8.2, 0.0
 
#define E6_VALUES 1.0, 1.5, 2.2, 3.3, 4.7, 6.8, 0.0
 
#define E3_VALUES 1.0, 2.2, 4.7, 0.0
 
#define E1_VALUES 1.0, 0.0
 
 
// First value of resistor in ohm
#define FIRST_VALUE 10
 
// last value of resistor in ohm
#define LAST_VALUE 1e6
 
enum { E1, E3, E6, E12, E24 };
 
enum { S2R, S3R, S4R };
 
// R_DATA handles a resistor: string value, value and allowed to use
struct R_DATA
{
 R_DATA() :
 e_use( true ),
 e_value( 0.0 )
 {}
 
 R_DATA( const std::string& aName, double aValue )
 {
 e_use = true;
 e_name = aName;
 e_value = aValue;
 }
 
 bool e_use;
 std::string e_name;
 double e_value;
};
 
class E_SERIES
{
public:
 E_SERIES();
 
 void Exclude( double aValue );
 
 void NewCalc();
 
 void Calculate();
 
 void SetSeries( uint32_t aSeries ) { m_series = aSeries; }
 void SetRequiredValue( double aValue ) { m_required_value = aValue; }
 
 // Accessor:
 const std::array<R_DATA,S4R+1>& GetResults() { return m_results; }
 
private:
 int buildSeriesData( const double aList[] );
 
 uint32_t combine2();
 
 void simple_solution( uint32_t aSize );
 
 void combine3( uint32_t aSize );
 
 void combine4( uint32_t aSize );
 
 /*
 * Strip redundant braces from three component result
 *
 * Example: R1+(R2+R3) become R1+R2+R3
 * and R1|(R2|R3) become R1|R2|R3
 * while R1+(R2|R3) or (R1+R2)|R3) remains untouched
 */
 void strip3();
 
 /*
 * Strip redundant braces from four component result
 *
 * Example: (R1+R2)+(R3+R4) become R1+R2+R3+R4
 * and (R1|R2)|(R2|R3) become R1|R2|R3|R4
 * while (R1+R2)|(R3+R4) remains untouched
 */
 void strip4();
 
private:
 std::vector<std::vector<R_DATA>> m_tables;
 
 /* Note: intermediate calculations use m_combined_table
 * if the biggest list is En, reserved array size should be 2*En*En of std::vector primary list.
 * 2 component combinations including redundant swappable terms are for the moment
 * ( using values between 10 ohms and 1Mohm )
 * 72 combinations for E1
 * 512 combinations for E3
 * 1922 combinations for E6
 * 7442 combinations for E12
 * 29282 combinations for E24
 */
 std::vector<R_DATA> m_combined_table; // intermediate 2R combinations
 
 std::array<R_DATA, S4R+1> m_results; // 2R, 3R and 4R results
 uint32_t m_series = E6; // Radio Button State
 double m_required_value = 0.0; // required Resistor
};