G4SurfBits Class Reference

#include <G4SurfBits.hh>

Public Member Functions
void	Clear ()
void	Compact ()
	G4SurfBits (const G4SurfBits &)
	G4SurfBits (unsigned int nbits=0)
void	Get (char *array) const
void	Get (G4int *array) const
unsigned int	GetNbits () const
unsigned int	GetNbytes () const
G4SurfBits &	operator= (const G4SurfBits &)
G4bool	operator[] (unsigned int bitnumber) const
void	Output (std::ostream &) const
void	Print () const
void	ResetAllBits (G4bool value=false)
void	ResetBitNumber (unsigned int bitnumber)
void	set (unsigned int nbits, const char *array)
void	set (unsigned int nbits, const G4int *array)
void	SetBitNumber (unsigned int bitnumber, G4bool value=true)
G4bool	TestBitNumber (unsigned int bitnumber) const
	~G4SurfBits ()

Data Fields
unsigned char *	fAllBits = nullptr

Protected Member Functions
void	ReserveBytes (unsigned int nbytes)

Protected Attributes
unsigned int	fNBits
unsigned int	fNBytes

Detailed Description

Definition at line 50 of file G4SurfBits.hh.

Constructor & Destructor Documentation

G4SurfBits() [1/2]

G4SurfBits::G4SurfBits

(

unsigned int

nbits = 0

)

Definition at line 36 of file G4SurfBits.cc.

                                         : fNBits(nBits)
{
  // G4SurfBits constructor.  All bits set to 0
 
  if (fNBits <= 0) fNBits = 0;
  fNBytes  = fNBits ? ((fNBits-1)/8) + 1 : 1;
  fAllBits = new unsigned char[fNBytes];
  // this is redundant only with libNew
  std::memset(fAllBits,0,fNBytes);
}

References fAllBits, fNBits, and fNBytes.

G4SurfBits() [2/2]

G4SurfBits::G4SurfBits

(

const G4SurfBits &

original

)

Definition at line 48 of file G4SurfBits.cc.

  : fNBits(original.fNBits), fNBytes(original.fNBytes)
{
  // G4SurfBits copy constructor
 
  fAllBits = new unsigned char[fNBytes];
  std::memcpy(fAllBits,original.fAllBits,fNBytes);
}

References fAllBits, and fNBytes.

~G4SurfBits()

G4SurfBits::~G4SurfBits

(

)

Definition at line 81 of file G4SurfBits.cc.

{
  // G4SurfBits destructor
 
  delete [] fAllBits;
}

References fAllBits.

Member Function Documentation

Clear()

void G4SurfBits::Clear

(

)

Definition at line 89 of file G4SurfBits.cc.

{
  // Clear the value.
 
  delete [] fAllBits;
  fAllBits = nullptr;
  fNBits   = 0;
  fNBytes  = 0;
}

References fAllBits, fNBits, and fNBytes.

Referenced by G4Voxelizer::BuildBitmasks(), G4Voxelizer::BuildEmpty(), G4TessellatedSolid::PrecalculateInsides(), and G4Voxelizer::Voxelize().

Compact()

void G4SurfBits::Compact

(

)

Definition at line 100 of file G4SurfBits.cc.

{
  // Reduce the storage used by the object to a minimun
 
  if (!fNBits || !fAllBits) return;
  unsigned int needed;
  for(needed=fNBytes-1; needed > 0 && fAllBits[needed]==0; ) { --needed; }
  ++needed;
 
  if (needed!=fNBytes)
  {
    unsigned char* old_location = fAllBits;
    fAllBits = new unsigned char[needed];
 
    std::memcpy(fAllBits,old_location,needed);
    delete [] old_location;
 
    fNBytes = needed;
    fNBits = 8*fNBytes;
  }
}

References fAllBits, fNBits, and fNBytes.

Get() [1/2]

void G4SurfBits::Get

(

char *

array

)

const

Definition at line 188 of file G4SurfBits.cc.

{
  // Copy all the bytes.
  std::memcpy(array, fAllBits, (fNBits+7)>>3);
}

References fAllBits, and fNBits.

Referenced by Get().

Get() [2/2]

void G4SurfBits::Get

(

G4int *

array

)

const

Definition at line 206 of file G4SurfBits.cc.

{
  // Get all the bytes.
 
  Get((char*)array);
}

References Get().

GetNbits()

unsigned int G4SurfBits::GetNbits ( ) const

inline

Definition at line 92 of file G4SurfBits.hh.

{ return fNBits; }

References fNBits.

Referenced by G4TessellatedSolid::InsideVoxels(), G4TessellatedSolid::SafetyFromOutside(), and G4TessellatedSolid::Voxelize().

GetNbytes()

unsigned int G4SurfBits::GetNbytes ( ) const

inline

Definition at line 93 of file G4SurfBits.hh.

{ return fNBytes; }

References fNBytes.

Referenced by G4TessellatedSolid::AllocatedMemory(), and G4Voxelizer::AllocatedMemory().

operator=()

G4SurfBits & G4SurfBits::operator=

(

const G4SurfBits &

rhs

)

Definition at line 58 of file G4SurfBits.cc.

{
  // G4SurfBits assignment operator
  if (this != &rhs)
  {
    //      TObject::operator=(rhs);
    fNBits   = rhs.fNBits;
    fNBytes  = rhs.fNBytes;
    delete [] fAllBits;
    if (fNBytes != 0)
    {
      fAllBits = new unsigned char[fNBytes];
      std::memcpy(fAllBits,rhs.fAllBits,fNBytes);
    }
    else
    {
      fAllBits = nullptr;
    }
  }
  return *this;
}

References fAllBits, fNBits, and fNBytes.

operator[]()

G4bool G4SurfBits::operator[] ( unsigned int  bitnumber ) const

inline

Definition at line 159 of file G4SurfBits.hh.

{
  return TestBitNumber(bitnumber);
}

References TestBitNumber().

Output()

void G4SurfBits::Output

(

std::ostream &

os

)

const

Definition at line 123 of file G4SurfBits.cc.

{
  // Print the value to the std::ostream
  for(unsigned int i=0; i<fNBytes; ++i)
  {
    unsigned char val = fAllBits[fNBytes - 1 - i];
    for (unsigned int j=0; j<8; ++j)
    {
      os << (G4bool)(val&0x80);
      val <<= 1;
    }
  }
}

References fAllBits, and fNBytes.

Print()

void G4SurfBits::Print

(

)

const

Definition at line 138 of file G4SurfBits.cc.

{
  // Print the list of active bits
  G4int count = 0;
  for(unsigned int i=0; i<fNBytes; ++i)
  {
    unsigned char val = fAllBits[i];
    for (unsigned int j=0; j<8; ++j)
    {
      if (val & 1) G4cout << " bit:" << count << " = 1" << G4endl;
      ++count;
      val = val >> 1;
    }
  }
}

References fAllBits, fNBytes, G4cout, and G4endl.

ReserveBytes()

void G4SurfBits::ReserveBytes ( unsigned int  nbytes )

protected

Definition at line 161 of file G4SurfBits.cc.

{
  // Reverse each bytes.
 
  if (nbytes > fNBytes)
  {
    // do it in this order to remain exception-safe.
    unsigned char *newBits = new unsigned char[nbytes];
    delete [] fAllBits;
    fNBytes = nbytes;
    fAllBits = newBits;
  }
}

References fAllBits, and fNBytes.

Referenced by set().

ResetAllBits()

void G4SurfBits::ResetAllBits

(

G4bool

value = false

)

Definition at line 155 of file G4SurfBits.cc.

{
  if (fAllBits != nullptr) std::memset(fAllBits, value ? 0xFF : 0, fNBytes);
}

References fAllBits, and fNBytes.

Referenced by G4Voxelizer::BuildEmpty().

ResetBitNumber()

void G4SurfBits::ResetBitNumber ( unsigned int  bitnumber )

inline

Definition at line 154 of file G4SurfBits.hh.

{
  SetBitNumber(bitnumber,false);
}

References SetBitNumber().

Referenced by G4Voxelizer::BuildEmpty(), G4MultiUnion::DistanceToOutVoxels(), and G4TessellatedSolid::PrecalculateInsides().

set() [1/2]

void G4SurfBits::set	(	unsigned int	nbits,
		const char *	array
	)

Definition at line 176 of file G4SurfBits.cc.

{
  // set all the bytes
  unsigned int nbytes=(nBits+7)>>3;
 
  ReserveBytes(nbytes);
 
  fNBits=nBits;
  std::memcpy(fAllBits, array, nbytes);
}

References fAllBits, fNBits, and ReserveBytes().

Referenced by G4Voxelizer::DisplayListNodes(), and set().

set() [2/2]

void G4SurfBits::set	(	unsigned int	nbits,
		const G4int *	array
	)

Definition at line 198 of file G4SurfBits.cc.

{
  // set all the bytes.
 
  set(nBits, (const char*)array);
}

References set().

SetBitNumber()

void G4SurfBits::SetBitNumber ( unsigned int  bitnumber, G4bool  value = true  )

inline

Definition at line 114 of file G4SurfBits.hh.

{
  // set bit number 'bitnumber' to be value
 
  if (bitnumber >= fNBits)
  {
    unsigned int new_size = (bitnumber/8) + 1;
    if (new_size > fNBytes)
    {
      if (new_size < 100 * 1024 * 1024) new_size *= 2;
      unsigned char *old_location = fAllBits;
      fAllBits = new unsigned char[new_size];
      std::memcpy(fAllBits,old_location,fNBytes);
      std::memset(fAllBits+fNBytes ,0, new_size-fNBytes);
      fNBytes = new_size;
      delete [] old_location;
    }
    fNBits = bitnumber+1;
  }
  unsigned int loc = bitnumber/8;
  unsigned char bit = bitnumber%8;
  if (value)
    fAllBits[loc] |= (1<<bit);
  else
    fAllBits[loc] &= (0xFF ^ (1<<bit));
}

References fAllBits, fNBits, and fNBytes.

Referenced by G4Voxelizer::BuildBitmasks(), G4Voxelizer::BuildEmpty(), G4MultiUnion::DistanceToInCandidates(), G4MultiUnion::DistanceToOutVoxels(), G4TessellatedSolid::PrecalculateInsides(), ResetBitNumber(), and G4TessellatedSolid::SetAllUsingStack().

TestBitNumber()

G4bool G4SurfBits::TestBitNumber ( unsigned int  bitnumber ) const

inline

Definition at line 141 of file G4SurfBits.hh.

{
  // Return the current value of the bit
 
  if (bitnumber >= fNBits) return false;
  unsigned int loc = bitnumber/8;
  unsigned char value = fAllBits[loc];
  unsigned char bit = bitnumber%8;
  G4bool result = (value & (1<<bit)) != 0;
  return result;
  // short: return 0 != (fAllBits[bitnumber/8] & (1<< (bitnumber%8)));
}

References fAllBits, and fNBits.

Referenced by G4Voxelizer::GetCandidatesAsString(), and operator[]().

Field Documentation

fAllBits

unsigned char* G4SurfBits::fAllBits = nullptr

Definition at line 104 of file G4SurfBits.hh.

Referenced by Clear(), Compact(), G4SurfBits(), Get(), G4Voxelizer::GetCandidatesVoxelArray(), operator=(), Output(), Print(), ReserveBytes(), ResetAllBits(), set(), SetBitNumber(), TestBitNumber(), and ~G4SurfBits().

fNBits

unsigned int G4SurfBits::fNBits

protected

Definition at line 108 of file G4SurfBits.hh.

Referenced by Clear(), Compact(), G4SurfBits(), Get(), GetNbits(), operator=(), set(), SetBitNumber(), and TestBitNumber().

fNBytes

unsigned int G4SurfBits::fNBytes

protected

Definition at line 109 of file G4SurfBits.hh.

Referenced by Clear(), Compact(), G4SurfBits(), GetNbytes(), operator=(), Output(), Print(), ReserveBytes(), ResetAllBits(), and SetBitNumber().

---

The documentation for this class was generated from the following files:

• source/geometry/solids/specific/include/G4SurfBits.hh
• source/geometry/solids/specific/src/G4SurfBits.cc