org.vishia.util

Class Bitfield

java.lang.Object

org.vishia.util.Bitfield

public class Bitfield
extends java.lang.Object

This class contains some basically operations to deal with bits in arrays or words.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Bitfield.IterBit

Field Summary

Fields

Modifier and Type	Field and Description
static long[][]	unconditionalORlong
static long[]	unconditionalORlongElem

Constructor Summary

Constructors

Constructor and Description
Bitfield()

Method Summary

Modifier and Type	Method and Description
static long[][]	addNewWords(long[][] src, long[][] or, long[] allBitsArg) Returns a new (copied) bit array with given src with given new word of bits newBits for a set of bits; sets unconditionally if all bits are existing in all second dimensions.
static boolean	checkAllset(long[][] cond, long[] allBitsArg) Checks whether in all cond OR elements all bits of allBitsArg are set.
static boolean	checkOrConditionMet(long[][] cond, long[] requ) Check whether all requested bits are set in one of the OR part of cond
static boolean	equals(long[][] c1, long[][] c2)
static boolean	equals(long[] c1, long[] c2)
static int	getLastBit(long bitWord)
static int	getLastBit(long[] bitArray) Returns the bit number of the last set bit in the given bitArray.
static long[][]	mergeWords(long[][] src, long[][] mask) Returns a new (copied) bit array with given src with given new word of bits newBits for a set of bits; It creates anyway a new instance of all bits and copies also all inner words ( bit fields).
static long[]	set_AddBits(long[] dst, long[] or)
static long[][]	setBits(long[][] src, long[] newBits) Builds either a new long[][] with all given and newBits whereby the newBits are merged in any index of the second dimension of src.
static long[]	setBits(long[] src, long[] newBits) Builds either a new long[] with all given and newBits or returns src if newBits == null or returns newBits if src==null.
static java.lang.CharSequence	writeBits(int[] bits)
static java.lang.CharSequence	writeBits(int[][] bits)
static java.lang.StringBuilder	writeBits(long[] bits)
static java.lang.StringBuilder	writeBits(long[][] bits)
static void	writeBits(java.lang.StringBuilder sb, int[] bits)
static void	writeBits(java.lang.StringBuilder sb, int[][] bits)
static void	writeBits(java.lang.StringBuilder sb, long[] bits)
static void	writeBits(java.lang.StringBuilder sb, long[][] bits)
static java.lang.CharSequence	writeBitsHex(long[] bits)
static void	writeBitsHex(java.lang.StringBuilder sb, long[] bits)
static java.lang.CharSequence	writeBitsObj(java.lang.Object obj)
static void	writeBitsObj(java.lang.StringBuilder sb, java.lang.Object obj)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

unconditionalORlong

public static long[][] unconditionalORlong

unconditionalORlongElem

public static long[] unconditionalORlongElem

Constructor Detail

Bitfield

public Bitfield()

Method Detail

getLastBit

public static int getLastBit(long[] bitArray)

Returns the bit number of the last set bit in the given bitArray. This is a usefully operation if some elements are addressed by a set bit, and the last set bit should be known for access this elements. Using a long value for the bits is recommended, because usual the CPU architecture is anyway 64 bit or can deal with int64_t. For any number of elements the bits are organized in an array with any length.

Returns:

shown on examples:

• -1 if bits == null, bits == int[] or all bits are 0.
• 0 if bits.length ==1 AND bits[0] == 0x00000001 because the last set bit is bit 0
• 8 if bits.length ==1 AND bits[0] == 0x000001ab because the last set bit is bit 8
• 65 if bits.length ==2 AND bits[1] == 0x00000002 because the last member which is !=0 is [1], and the last bit there is bit1

addNewWords

public static long[][] addNewWords(long[][] src,
                                   long[][] or,
                                   long[] allBitsArg)

Returns a new (copied) bit array with given src with given new word of bits newBits for a set of bits; sets unconditionally if all bits are existing in all second dimensions. It creates anyway a new instance of all bits and copies also all inner words ( bit fields).

Parameters:

src - null or given bits.

or - null or new bits to add in second dimension. May have more second dimensions also. Also if it is null, a new instance for return is built, see #set_addNewBits(long[][], long[][], long[]).

allBitsArg - If all these bits are given in any of the second dimension, then set to unconditionalORlong, then the returned value is unconditionalORlong.

Returns:

mergeWords

public static long[][] mergeWords(long[][] src,
                                  long[][] mask)

Returns a new (copied) bit array with given src with given new word of bits newBits for a set of bits; It creates anyway a new instance of all bits and copies also all inner words ( bit fields). If only one evoutSrc is on each evin-Join, then it is a simple AND, all bits are stored in condBits[0][0]. All bits builds boolean condition to AND.

If you have more as one evoutSrc with conditions on any evin-Join then you may have a lot of OR combinations. The number of combinations is the product of all OR event input's conditions. It means 8 event inputs, 3 of them have 2 evouSrc, and one has 3 evoutSrc, you get 2*2*2*3 = 24 OR variants or condition[24][]. This variants are regarded also as OR result of further event processing (may be removed because "all" conditions), and also as selection for doutSrc of the din pins if the doutSrc comes from conditional outputs.

• If the first evin-Join has 2 evoutSrc, then we have an OR of this both, but an AND of the other evoutSrc2: Seems to be evoutSrc1 has 0x1 and 0x2, evoutSrc2 has 0x4, then the result is 0x05 0x06
• If the first evin-Join has 1 evoutSrc, and the second has 2 evoutSrc3: Seems to be evoutSrc1 has 0x1, evoutSrc2 has 0x4 and 0x8, then

     0x01 0x01      //zOrS = 1
     0x04 0x08      //zOrS = 1
     ---------
     0x05 0x09  =>0x0d

  The 0x0d = 1101 is the resulting condition on the prepO of this FBlock for further usage. Condition bit 0x02 is missing.
• If both have two, evoutSrc1 = 0x01, 0x02, evoutSrc2 = 0x04 0x08:

     0x01 0x02 0x01 0x02      //zOrS = 1
     0x04 0x04 0x08 0x08      //zOrS = 2, fill 2 elements one after another with one evoutSrc-cond.
     -------------------
     0x05 0x06 0x09 0x0a  =>0x0f

  The resulting condition is 0x0f. If that are all condition bits used for this evinMdl, then no condition is stored on output.
• If you have a 3th evin-Join but only with one connection, it is similar, not more complex:

     0x01 0x02 0x01 0x02      //zOrS = 1
     0x04 0x04 0x08 0x08      //zOrS = 2, fill 2 elements one after another with one evoutSrc-cond.
     0x10 0x10 0x10 0x10      //zOrS = 4
     -------------------
     0x15 0x16 0x19 0x1a  =>0x1f

• If you have a 3 evin-Join each with two evoutSrc with each on condition, it is

     0x01 0x02 0x01 0x02 0x01 0x02 0x01 0x02      //zOrS = 1
     0x04 0x04 0x08 0x08 0x04 0x04 0x08 0x08      //zOrS = 2, fill 2 elements one after another with one evoutSrc-cond.
     0x10 0x10 0x10 0x10 0x20 0x20 0x20 0x20      //zOrS = 4
     ---------------------------------------
     0x15 0x16 0x19 0x1a 0x25 0x26 0x29 0x2a =>0x2f

• If any evoutSrc has already more as one conditions, means Evout_FBcl#condBits are for example [3][] then this conditions are just similar handled as more evoutSrc to this evin Join. It means the number of variants is already increased for this example by a factor of 3.

Parameters:

src - null or given bits.

or - null or new bits to add in second dimension. May have more second dimensions also. Also if it is null, a new instance for return is built, see #set_addNewBits(long[][], long[][], long[]).

allBitsArg - If all these bits are given in any of the second dimension, then set to unconditionalORlong, then the returned value is unconditionalORlong.

Returns:

set_AddBits

public static long[] set_AddBits(long[] dst,
                                 long[] or)

setBits

public static long[] setBits(long[] src,
                             long[] newBits)

Builds either a new long[] with all given and newBits or returns src if newBits == null or returns newBits if src==null. Given bit arrays are never changed (read only).

Parameters:

src - given bits, maybe null

newBits - new bits, maybe null

Returns:

given and new bits are set here.

setBits

public static long[][] setBits(long[][] src,
                               long[] newBits)

Builds either a new long[][] with all given and newBits whereby the newBits are merged in any index of the second dimension of src. or returns src if newBits == null or returns newBits if src==null. Given bit arrays are never changed (read only).

Parameters:

src - given bits, maybe null

newBits - new bits, maybe null

Returns:

given and new bits are set here.

getLastBit

public static int getLastBit(long bitWord)

equals

public static boolean equals(long[][] c1,
                             long[][] c2)

equals

public static boolean equals(long[] c1,
                             long[] c2)

checkAllset

public static boolean checkAllset(long[][] cond,
                                  long[] allBitsArg)

Checks whether in all cond OR elements all bits of allBitsArg are set. This is then unconditionally.

Parameters:

cond - given condition

allBitsArg - all condition bits which are possible

Returns:

true if cond contains all bits of allBitsArg

checkOrConditionMet

public static boolean checkOrConditionMet(long[][] cond,
                                          long[] requ)

Check whether all requested bits are set in one of the OR part of cond

Parameters:

requ - given bits from #condBits or from temporary such bits.

cond - requested bits, all should be set in given

Returns:

true if all given & req == req for all elements

writeBits

public static void writeBits(java.lang.StringBuilder sb,
                             long[] bits)

writeBitsHex

public static void writeBitsHex(java.lang.StringBuilder sb,
                                long[] bits)

writeBitsHex

public static java.lang.CharSequence writeBitsHex(long[] bits)

writeBits

public static void writeBits(java.lang.StringBuilder sb,
                             long[][] bits)

writeBits

public static java.lang.StringBuilder writeBits(long[] bits)

writeBits

public static java.lang.StringBuilder writeBits(long[][] bits)

writeBits

public static void writeBits(java.lang.StringBuilder sb,
                             int[] bits)

writeBits

public static void writeBits(java.lang.StringBuilder sb,
                             int[][] bits)

writeBits

public static java.lang.CharSequence writeBits(int[] bits)

writeBits

public static java.lang.CharSequence writeBits(int[][] bits)

writeBitsObj

public static void writeBitsObj(java.lang.StringBuilder sb,
                                java.lang.Object obj)

writeBitsObj

public static java.lang.CharSequence writeBitsObj(java.lang.Object obj)